drivers library
Driver registries for extending Routed integrations.
Import this when providing custom cache/storage/session drivers or when inspecting driver metadata.
Classes
- CacheDriverDocContext
- Context provided to cache driver documentation builders.
- CacheDriverRegistry
- A registry for managing cache drivers.
- DriverConfigContext
- Context provided to cache driver configuration builders.
- LocalStorageDisk
- Local file system backed disk. Resolves local disk roots with sensible defaults.
- SessionDriverDocContext
- Context object supplied to a SessionDriverDocBuilder.
- SessionDriverRegistry
- Registry responsible for managing session driver registrations.
- StorageDriverContext
- Context for a storage driver, providing necessary dependencies and configuration.
- StorageDriverDocContext
- Context for generating documentation for a storage driver.
- StorageDriverRegistry
- A registry for managing storage driver registrations.
Typedefs
-
CacheDriverDocBuilder
= List<
ConfigDocEntry> Function(CacheDriverDocContext context) - A builder function that generates configuration documentation entries for a cache driver.
- CacheStore = Store
-
DriverConfigBuilder
= Map<
String, dynamic> Function(DriverConfigContext context) - A builder that constructs the final configuration for a cache driver.
-
DriverConfigValidator
= void Function(Map<
String, dynamic> config, String driverName) - A validator invoked after a cache driver's configuration has been built.
- SessionDriverBuilder = SessionConfig Function(SessionDriverBuilderContext context)
- Signature for a function that converts a SessionDriverBuilderContext to a fully-formed SessionConfig instance.
-
SessionDriverDocBuilder
= List<
ConfigDocEntry> Function(SessionDriverDocContext context) - Signature for a callback that returns documentation describing a driver’s configuration options.
- StorageDiskBuilder = StorageDisk Function(StorageDriverContext context)
- A function that builds a StorageDisk using the provided StorageDriverContext.
-
StorageDriverDocBuilder
= List<
ConfigDocEntry> Function(StorageDriverDocContext context) - A function that generates a list of ConfigDocEntry for documentation purposes using the provided StorageDriverDocContext.
Exceptions / Errors
- ConfigurationException
- Exception raised when cache driver configuration is invalid.