sealed_unions

Visão geral do pacote

Orientação gerada a partir de informações públicas. Apenas para referência.

Sealed Unions for Dart é um pacote que oferece uma maneira segura por tipo para modelar tipos soma (também conhecidos como tipos de dados algébricos) no Dart. Ele permite que os desenvolvedores definam um conjunto finito de casos possíveis para um tipo, garantindo correspondência de padrões exaustiva em tempo de compilação. Isso ajuda a prevenir erros em tempo de execução e melhora a clareza do código ao lidar com múltiplos estados ou resultados distintos. O pacote é particularmente útil em padrões de programação funcional dentro de aplicativos Flutter e Dart.

Casos de uso

Gerenciando transições de estado na interface do usuário
Modelagem de respostas da API com múltiplas variações de sucesso/falha
Implementando máquinas de estado finito
Gerenciando o tratamento de erros com resultados tipados
Construindo modelos de domínio com distinções claras de caso

Principais recursos

Segurança em tempo de compilação para casos de união
Suporte a correspondência de padrões exaustiva
Sintaxe limpa para definir tipos selados
Integração com a segurança nula do Dart
Suporte para uniões aninhadas e recursivas

Indicado para

Desenvolvedores usando padrões de programação funcional
Aplicativos Flutter que exigem gerenciamento de estado robusto
Equipes que priorizam segurança de tipo e manutenibilidade
Projetos com lógica condicional complexa
Aplicações que precisam de tratamento claro de erros e resultados

Considerações

Requer compreensão de tipos soma e correspondência de padrões
Pode aumentar a curva inicial de aprendizado para novos membros da equipe
Não adequado para estruturas de dados simples sem lógica de variante
Limitado às restrições de análise estática do Dart
Melhor usado em conjunto com regras de linter para segurança ótima

README original

Snapshot do README original do repositório-fonte vinculado. Consulte o repositório para o conteúdo mais recente.

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

Buscar pacotes, repositórios e categorias de apps

Instalar pacote