coralline library

Classes

ComplexComputation<T>
A versatile custom node computation for handling multiple inbound dependencies (N:1).
Coral<T>
The fundamental declarative node in the CoralNode topological graph that represents an observable, typed data flow.
CoralBroadcaster<T>
A multi-cast proxy that splits a single declarative pipeline to share a single upstream among multiple consumers.
CoralComputation<T>
The foundational abstract base class for building custom declarative nodes in the graph.
CoralController<T>
The imperative entry point (Source) that bridges dynamic data into the declarative Coral pipeline.
CoralCoupler<T>
Provides a dynamic connector that allows hotswapping or coldswapping the middle section of a Coral pipeline at runtime.
CorallineLifecycleStatus
A status interface representing the current lifecycle state of a CoralNode node.
CorallineSnapshot
Core Concept (State Container): The base sealed class for all snapshot types, representing an immutable, atomic state container at a specific point in time.
CorallineSnapshotDelegator<S extends CorallineSnapshot>
CorallineTerminal<C extends CoralNode>
Core Concept (Separation of Concerns): The terminal Sink of the topological graph, serving as the definitive bridge between CoralNode's declarative pipelines and external imperative environments (such as Flutter's Widget tree or traditional Dart Streams).
CorallineTerminalIntent
Core Concept (Error Delegation Intent): Defines the intended behavior for handling uncaught exceptions that occur asynchronously or unexpectedly within the topological pipeline during its lifecycle.
CoralNode
Core Concept: The abstract base class representing any reactive node participating in the CORAL architecture. It acts as the common base for all single-value nodes (Coral) and bundled nodes (Trunk).
CoralProvider<T>
CoralSnapshot<T>
An immutable, atomic container that encapsulates the precise state and data of a Coral node at a specific point in time.
CoralTerminal<T>
Core Concept: A concrete CorallineTerminal designed specifically for 1:1 Coral pipelines.
SimplexComputation<T>
A high-performance custom node computation optimized for a single inbound dependency (1:1).
Trunk<T>
The structural foundation for managing multiple Coral pipelines as a single, unified topological entity.
TrunkController<T>
The imperative entry point (Source) that bridges dynamic collections of Coral lines into a declarative Trunk pipeline.
TrunkCoupler<T>
Provides a dynamic connector that allows hotswapping or coldswapping the middle section of a Trunk (multi-node) pipeline at runtime.
TrunkProvider<T>
TrunkSnapshot<T>
A snapshot representing the immutable state of a Trunk at a specific point in time.
TrunkTerminal<T>
Core Concept: A concrete CorallineTerminal designed specifically for Trunk pipelines.

Mixins

CorallineLifecycleAware
A mixin for computations to intercept and react to downstream lifecycle state changes.
CorallineTerminalIntentAware
A mixin for computations to receive contextual metadata intent updates from downstream terminals.
CoralSnapshotDelegator<T>
Core Concept (Snapshot Delegation): A mixin that forwards all CoralSnapshot properties and accessors directly to the implementing class.
TrunkSnapshotDelegator<T>
Core Concept (Snapshot Delegation): A mixin that forwards all TrunkSnapshot properties and accessors directly to the implementing class.

Extension Types

CoralIterableElements
Core Concept (Collection Element Proxy): A dedicated proxy wrapper for Coral<Iterable<E>> to perform element-wise transformations and computations safely and defensively.
CoralKeyedIterableElements
Core Concept (Keyed Collection Element Proxy): A dedicated proxy wrapper for Coral<Iterable<E>> to perform keyed element-wise transformations and divergence operations safely and lazily.
CoralListElements
Core Concept (List Element Proxy): A dedicated proxy wrapper for Coral<List<E>> to perform list-specific transformations and lookup computations.
CoralMapElements
Core Concept (Map Element Proxy): A dedicated proxy wrapper for Coral<Map<K, V>> to perform map-specific lookup, mapping, and filtering operations.
CoralSetElements
Core Concept (Set Element Proxy): A dedicated proxy wrapper for Coral<Set<E>> to perform set-specific transformations and operations while preserving set types.

Extensions

CoralBroadcasterDebugExtension on CoralBroadcaster
CoralCollectionExtension on Iterable<Coral<T>>
Core Concept (Collection Utility): Provides convenience methods to inspect and manipulate an Iterable of Coral nodes as a cohesive group, without needing to manually map over their snapshots.
CoralComputationDebugExtension on CoralComputation
CoralComputationExtension on Coral<S>
CoralControllerDebugExtension on CoralController
CoralCouplerDebugExtension on CoralCoupler
CoralExtension on Coral<S>
CorallineDebugExtension on CoralNode
Extension to provide zero-overhead debugging capabilities to CoralNode objects.
CorallineSnapshotCollectionExtension on Iterable<E>
Core Concept (Snapshot Collection Utility): Provides convenience methods to inspect and filter an Iterable of CorallineSnapshots.
CorallineSnapshotDelegatorCollectionExtension on Iterable<E>
Core Concept (Delegator Collection Utility): Provides convenience methods to inspect and filter an Iterable of objects that implement CorallineSnapshotDelegator (such as Coral or Trunk).
CorallineTerminalDebugExtension on CorallineTerminal<CoralNode>
CoralProviderComputationExtension on CoralProvider<S>
Core Concept (Provider Delegation): A convenience extension that allows computation operators to be called directly on any CoralProvider (such as Coralline or custom components), automatically delegating the operation to the underlying Coral node.
CoralProviderExtension on CoralProvider<S>
CoralSnapshotCollectionExtension on Iterable<CoralSnapshot<T>>
Core Concept (Snapshot Collection Utility): Provides convenience methods to inspect and manipulate an Iterable of CoralSnapshots as a cohesive group.
FutureCollectionThatMixesTrunk on Iterable<Future<T>>
A convenience extension that groups multiple Futures into a lifecycle-managed Trunk.
FutureThatMixesCoral on Future<T>
A convenience extension that bridges Dart's Future with the Coralline pipeline.
IterableCoralElementsExtension on Coral<Iterable<E>>
KeyedIterableCoralElementsExtension on Coral<Iterable<E>>
ListCoralElementsExtension on Coral<List<E>>
MapCoralElementsExtension on Coral<Map<K, V>>
SetCoralElementsExtension on Coral<Set<E>>
StreamCollectionThatMixesTrunk on Iterable<Stream<T>>
A convenience extension that groups multiple Streams into a lifecycle-managed Trunk.
StreamControllerThatMixesCoral on StreamController<T>
A convenience extension that bridges StreamController with the Coralline pipeline.
StreamThatMixesCoral on Stream<T>
A convenience extension that bridges Dart's Stream with the Coralline pipeline.
TrunkComputationExtension on Trunk<S>
TrunkExtension on Trunk<T>
TrunkProviderComputationExtension on TrunkProvider<S>
TrunkProviderExtension on TrunkProvider<T>

Constants

manifestSync → const _ManifestSync
Annotation marking manifest() methods that require strict dependency synchronization.

Exceptions / Errors

CoralBroadcasterLineDormantAccessError
Core Concept: Thrown when a snapshot or computation query is executed on a dormant or deactivated _BroadcasterLine. This is a Fail-Fast lifecycle contract violation specific to broadcaster lines.
CorallineException
Design Philosophy (Diagnostics): The Coralline framework establishes a clear boundary between recoverable runtime failures and structural programming bugs:
CorallineTopologyError
Core Concept: Thrown when a topological error is detected during graph construction or attachment, such as placing an intent-aware Computation upstream of a broadcaster.
CoralNodeReentrancyError
Core Concept: Thrown when a reentrant call to _pushDirty is detected on a _DirtyPoint. This is a programmatic error indicating a cyclic update or structural bug.
CoralNodeReleaseViolationException
Core Concept: Thrown when a topological connection rule is violated at runtime, such as trying to release a node that is not attached to the joint.
CoralSnapshotExtractionException
Core Concept: Thrown when a developer attempts to extract data from an invalid state (e.g., isEmpty or isDamaged) of a CoralSnapshot or TrunkSnapshot.
CoralSnapshotStateException
Core Concept: Thrown when a developer attempts to query state metadata (like error or stackTrace) from a snapshot state where it does not exist (e.g., querying error on a valid snapshot).