Expand description
Rust SDK for Lix.
Embedded version control for files and data.
§Quick start
let lix = lix::open_lix().await?;open_lix opens an in-memory repository. Add a storage adapter with
OpenLixBuilder::with_storage when persistence is needed.
Re-exports§
pub use telemetry::bind_session;pub use storage::Memory;pub use lix_schema as schema_v1;
Modules§
- plugin
- Lix plugin authoring and runtime integration.
- snapshot
- storage
- Primary storage API.
- telemetry
- wasm
- General WebAssembly compute configuration for Lix.
Structs§
- Blob
- Immutable, cheaply cloned binary SQL value.
- Branch
Id - Callback
Open Progress Sink - Adapts a Rust closure to
OpenProgressSink. - Canonical
Plugin Key - Canonical
Schema Key - Create
Branch Options - Options for creating a new branch from the session’s active branch.
- Create
Branch Receipt - Receipt returned after creating a branch.
- Execute
Batch Builder - Configures one atomic SQL batch execution.
- Execute
Batch Statement - One SQL statement to execute as part of an atomic batch.
- Execute
Builder - Configures one SQL statement execution.
- Execute
Result - Result of executing one SQL statement through engine.
- FileId
- Json
- Canonical JSON text carried by a SQL value.
- Lix
- Clonable handle for a Lix repository.
- LixError
- Structured error type surfaced by Lix to every SDK binding.
- LixNotice
- LixPath
- A validated absolute Lix logical filesystem path.
- LixTransaction
- Merge
Branch Options - Options for merging another branch into this session’s active branch.
- Merge
Branch Preview - Merge
Branch Preview Options - Options for previewing a merge from another branch into this session’s active branch.
- Merge
Branch Receipt - Receipt returned after merging a branch.
- Merge
Change Stats - Merge
Conflict - Merge
Conflict Side - Observe
Event - Observe
Events - A live query observation bound to the storage session owned by its Lix handle.
- Open
Another Session Builder - Configures another independent session for an open Lix repository.
- Open
LixBuilder - Configures the primary session for a Lix repository.
- Open
LixFrom Snapshot Builder - Restores a snapshot into fresh storage and then opens the resulting Lix.
- Open
Migration Report - The migration performed by this open, if any.
- Open
Progress - One Lix-open progress snapshot.
- Open
Report - Immutable facts about how this handle was opened.
- Redo
Receipt - Result
RowRef - Zero-copy row view with access to the result-set column names.
- Row
- One owned row returned by a query.
- RowRef
- Opaque address of one logical row in one Lix relation.
- Server
Options - Configures the server associated with a local Lix repository.
- Session
Transaction - Shared
Str - Immutable UTF-8 backed by a cheaply cloned byte buffer.
- SqlQuery
Result - Switch
Branch Options - Options for switching a session to another branch.
- Switch
Branch Receipt - Receipt returned after switching to another branch.
- Transaction
Execute Builder - Configures one SQL statement inside an explicit transaction.
- Undo
Receipt - Wire
Query Result
Enums§
- Merge
Branch Outcome - Merge
Conflict Change Kind - Merge
Conflict Kind - Nullable
KeyFilter - Open
Phase - Coarse, stable phases suitable for a CLI, loading screen, or logs.
- Result
Column Type - Stable SQL result type exposed at language and protocol boundaries.
- Server
Mode - Server behavior for an opened local Lix repository.
- Value
- Wire
Value
Constants§
- ANONYMOUS_
ACCOUNT_ ID - Fixed author used when a host opens a session without an authenticated account.
- GLOBAL_
BRANCH_ ID - Reserved high UUID sentinel for repository-global state.
- SYSTEM_
ACCOUNT_ ID - Fixed author for engine-owned initialization and maintenance changes.
Traits§
- Open
Progress Sink - A non-blocking observer for Lix open and automatic migration.
- TryFrom
Value
Functions§
- lix_
schema_ definition - lix_
schema_ definition_ json - open_
lix - Starts configuring the primary session for a Lix repository.
- validate_
lix_ path_ segment - Validates one literal segment of a Lix logical filesystem path.
- validate_
lix_ schema - validate_
lix_ schema_ definition