SessionDriverRegistry class

Registry responsible for managing session driver registrations.

Third-party packages can use register and unregister to expose their own drivers at runtime. The class is a thin singleton wrapper around a map, deliberately avoiding any global state beyond the registry itself.

Properties

entries → Map<String, _SessionDriverRegistration>
no setterinherited
entryNames → Iterable<String>
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

availableDrivers({Iterable<String> include = const []}) → List<String>
Returns a sorted list of available driver names, ensuring that include is always present in the result.
builderFor(String driver) → SessionDriverBuilder?
Retrieves the builder associated with driver or null when absent.
contains(String driver) → bool
Returns true if a registration exists for driver.
containsEntry(String name) → bool
inherited
documentation({required String pathBase}) → List<ConfigDocEntry>
Collates documentation from all registered drivers.
ensureRequirements(String driver, SessionDriverBuilderContext context, _SessionDriverRegistration registration) → void
getEntry(String name) → _SessionDriverRegistration?
inherited
normalizeName(String name) → String
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onDuplicate(String name, _SessionDriverRegistration existing, bool overrideExisting) → bool
register(String driver, SessionDriverBuilder builder, {SessionDriverDocBuilder? documentation, bool overrideExisting = true, SessionDriverValidator? validator, List<String> requiresConfig = const []}) → void
Registers a new session driver.
registerEntry(String name, _SessionDriverRegistration value, {bool overrideExisting = true}) → bool
inherited
registrationFor(String driver) → _SessionDriverRegistration?
runValidator(String driver, SessionDriverBuilderContext context, _SessionDriverRegistration registration) → void
toString() → String
A string representation of this object.
inherited
unregister(String driver) → void
Removes the registration associated with driver if it exists.
unregisterEntry(String name) → bool
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

instance → SessionDriverRegistry
Singleton accessor.
final