datalocal_core library
Pure Dart domain primitives for the DataLocal 2.0 API.
This temporary entrypoint allows the new core to coexist with the legacy
Flutter API while version 2 is under development. It will be folded into
package:datalocal/datalocal.dart before the stable 2.0 release.
Classes
- DataLocalAesGcmEncryptionProvider
- AES-256-GCM authenticated encryption with 96-bit random nonces.
- DataLocalAtomicBatchStorage
- Optional storage capability for applying a logical batch atomically.
- DataLocalClock
- Clock boundary used to make document metadata deterministic in tests.
-
DataLocalCodec<
T> - Converts application values to and from DataLocal map documents.
-
DataLocalCollection<
T> - A typed set of documents sharing a storage namespace and codec.
- DataLocalCommitEvent
- DataLocalDatabase
- Open DataLocal 2.0 database instance.
-
DataLocalDocument<
T> - Immutable snapshot of a committed document.
- DataLocalDocumentChange
- DataLocalDocumentIdGenerator
- Generates and validates opaque document identifiers.
- DataLocalDocumentValidator
- Validates and freezes values accepted by the default map codec.
- DataLocalEncryptedEnvelope
- Storage-independent authenticated-encryption envelope.
- DataLocalEncryptionContext
- Identifies the record being encrypted and becomes authenticated metadata.
- DataLocalEncryptionProvider
- Authenticated-encryption boundary.
- DataLocalFieldPath
- A validated dot-separated path into a document map.
- DataLocalFilter
- An immutable field predicate used by DataLocalQuery.
-
DataLocalFunctionalCodec<
T> - A codec composed from application-provided encode and decode functions.
- DataLocalIntegrityVerifyingStorage
- Optional post-recovery integrity hook for manifest-based adapters.
- DataLocalKeyMaterial
- Secret key bytes and their non-secret stable identifier.
- DataLocalKeyProvider
- Supplies active and historical keys without coupling encryption to an OS.
- DataLocalMapCodec
- Identity-style codec for applications that use document maps directly.
- DataLocalMemoryKeyProvider
- In-memory key provider for tests and ephemeral databases.
- DataLocalMemoryStorage
- In-memory storage used for unit tests and ephemeral databases.
- DataLocalMetadata
- Immutable system metadata stored separately from user document fields.
- DataLocalMissingField
-
Sentinel distinguishing a missing field from a field containing
null. - DataLocalNoEncryptionProvider
- Explicit plaintext provider for caches and tests.
- DataLocalOrder
- An immutable ordering clause used by DataLocalQuery.
-
DataLocalQuery<
T> - An immutable, lazily executed query over a DataLocal collection.
- DataLocalQueryCursor
- A stable position that can resume an ordered DataLocalQuery.
-
DataLocalQuerySnapshot<
T> - Immutable result produced by executing or watching a query.
- DataLocalSecureDocumentIdGenerator
- DataLocalStorage
- Persistence boundary implemented by every DataLocal storage backend.
- DataLocalStorageBatchOperation
- One write or deletion in an atomic storage batch.
- DataLocalStorageCapabilities
- Features a storage adapter can perform natively.
- DataLocalStorageContext
- Immutable configuration supplied when a storage adapter is opened.
- DataLocalStoredRecord
- Encoded record passed across the storage boundary.
- DataLocalSystemClock
- DataLocalWriteBatch
- Synchronous batch builder committed by DataLocalDatabase.writeBatch.
Enums
- DataLocalCommitPhase
- DataLocalErrorCode
- Stable categories for errors callers may handle programmatically.
- DataLocalFilterOperator
- Operators supported by a DataLocalFilter.
- DataLocalMutationType
- DataLocalNullOrder
- Controls where null and missing values appear in an ordered query.
Typedefs
-
DataLocalFailureInjector
= FutureOr<
void> Function(DataLocalCommitPhase phase)
Exceptions / Errors
- DataLocalClosedException
- DataLocalConflictException
- DataLocalCorruptionException
- DataLocalEncryptionException
- DataLocalException
- Base class for expected DataLocal failures.
- DataLocalInitializationException
- DataLocalMigrationException
- DataLocalNotFoundException
- DataLocalReadException
- DataLocalSerializationException
- DataLocalUnsupportedException
- DataLocalValidationException
- DataLocalWriteException