sealed_unions

Paketübersicht

Aus öffentlichen Paketdaten erstellte Orientierung.

Sealed Unions for Dart ist ein Paket, das eine typensichere Möglichkeit bietet, Summenarten (auch als algebraische Datentypen bekannt) in Dart zu modellieren. Es ermöglicht Entwicklern, eine endliche Menge möglicher Fälle für einen Typ zu definieren, wodurch eine erschöpfende Musterabgleichung zur Kompilierzeit gewährleistet wird. Dies hilft, Laufzeitfehler zu vermeiden und die Codeklarheit zu verbessern, wenn mit mehreren unterschiedlichen Zuständen oder Ergebnissen gearbeitet wird. Das Paket ist besonders nützlich bei funktionale Programmiermuster innerhalb von Flutter- und Dart-Anwendungen.

Anwendungsfälle

Zustandsübergänge in der Benutzeroberfläche behandeln
Modellierung von API-Antworten mit mehreren Erfolgs-/Fehlervarianten
Endliche Zustandsmaschinen implementieren
Fehlerbehandlung mit typisierten Ergebnissen verwalten
Domänenmodelle mit klaren Fallunterscheidungen erstellen

Hauptmerkmale

Laufzeit-Sicherheit für Union-Fälle
Umfassende Musterabgleich-Unterstützung
Klare Syntax zur Definition von versiegelten Typen
Integration mit Dart's Null-Sicherheit
Unterstützung für verschachtelte und rekursive Vereinigungen

Geeignet für

Entwickler, die funktionale Programmiermuster verwenden
Flutter-Anwendungen, die eine robuste Zustandsverwaltung erfordern
Teams, die Typsicherheit und Wartbarkeit priorisieren
Projekte mit komplexer bedingter Logik
Anwendungen, die eine klare Fehler- und Ergebnisbehandlung erfordern

Hinweise

Erfordert Verständnis von Summenarten und Musterabgleich
Kann die ursprüngliche Lernkurve für neue Teammitglieder erhöhen
Nicht geeignet für einfache Datenstrukturen ohne Variantenlogik
Eingeschränkt durch die statischen Analysebeschränkungen von Dart
Am besten in Verbindung mit Linter-Regeln verwendet, um optimale Sicherheit zu gewährleisten

Original-README

Originaler README-Schnappschuss aus dem verknüpften Quell-Repository. Aktuelle Inhalte finden Sie im Repository.

ACKNOWLEDGEMENTS

This library is a port of JavaSealedUnions originally created by Francisco (Paco) Estévez .

Dart port by George Medve with assistance from Jan Knotek and Brian Egan.

RATIONALE

Sealed classes are used for representing restricted class hierarchies, when a value can have one of the types from a limited set, but cannot have any other type. They are, in a sense, an extension of enum classes: the set of values for an enum type is also restricted, but each enum constant exists only as a single instance, whereas a subclass of a sealed class can have multiple instances which can contain state. Sealed classes are available in languages like Kotlin, or C#. Tagged unions are common on Swift and Rust.

We highly recommend reading the Rationale for the readme of JavaSealedUnions for an indepth explanation of the idea and application of the library.

MOTIVATION

This library was heavily inspired by RxEither and the wonderful Domain Driven Design (DDD) talk by Scott Wlaschin. This video by Scott Wlaschin will inspire you on how to apply DDD: Domain Driven Design, F# and Types

USAGE

The following example project: MVI Sealed Unions demonstrates the library application in a Flutter app.

INSTALLING

1. Depend on it

Add this to your package's pubspec.yaml file:

dependencies:
  sealed_unions: "^3.0.3+1"

2.Install it

You can install packages from the command line:

with Flutter:

flutter packages get

with pub:

pub get

3. Import it

Now in your Dart code, you can use:

// for example import Union4
import 'package:sealed_unions/union_4.dart';

License

The Apache Software License, Version 2.0

See LICENSE.md

Pakete, Repositories und App-Kategorien suchen

Paket installieren