pottery library

Classes

LocalPottery
A widget that associates existing pots with new values and makes them accessible from descendants in the tree via the pots.
Pot<T>
A class that instantiates and caches an object of type T until it is discarded.
PotDescription
A class that describes the details of a Pot.
PotEvent
A class that represents an event related to Pot.
Pottery
A widget that controls the availability of particular pots according to the widget lifecycle.
ReplaceablePot<T>
A variant of Pot with the replace method that allows its factory to be replaced.

Enums

PotEventKind
The types of events that can occur in relation to Pot.

Extensions

NearestPotOf on Pot<T>
Extension on Pot used in relation to LocalPottery.

Typedefs

LocalPotteryObjects = Map<Pot<Object?>, Object?>
The signature of a map consisting of pots and the objects they hold.
PotDisposer<T> = void Function(T)
The signature of a callback that receives an object of type T to be disposed of.
PotListenerRemover = Future<void> Function()
The signature of a function that removes the listener added by listen().
PotObjectFactory<T> = T Function()
The signature of a Singleton factory that creates and returns an object of type T.
PotOverrides = Map<Pot<Object?>, PotObjectFactory<Object?>>
The signature of a map consisting of pots and factories.
PotReplacements = Map<ReplaceablePot<Object?>, PotObjectFactory<Object?>>
The signature of a map consisting of replaceable pots and factories.
ScopedPottery = LocalPottery
An alias of LocalPottery.

Exceptions / Errors

PotNotReadyException
Exception thrown if a pot with no factory is used.
PotReplaceError
Error thrown if replaceForTesting is used when Pot.forTesting is not enabled.