Struct IrohDb 

pub struct IrohDb { /* private fields */ }

A local-first embedded database with one default private domain.

Implementations

impl IrohDb

pub fn builder(root: impl AsRef<Path>) -> IrohDbBuilder

Begins opening a database with an application migration registry.

pub async fn open(root: impl AsRef<Path>) -> Result<Self, DbError>

Opens or creates an offline embedded database. No endpoint is started.

pub async fn open_with_key_provider( root: impl AsRef<Path>, credentials: Arc<dyn KeyProvider>, ) -> Result<Self, DbError>

Opens a database with an application-managed durable key provider.

pub async fn create_in_domain( root: impl AsRef<Path>, seed: &DomainSeed, ) -> Result<Self, DbError>

Creates a new per-device identity inside an existing encrypted domain.

pub fn collection<Record: IrohRecord>(&self) -> Collection<Record>

Opens a strongly typed collection in the default private domain.

pub fn transaction(&self) -> Transaction

Starts an atomic transaction in the default private domain.

pub fn blobs(&self) -> Blobs

Returns the encrypted first-class blob API for the default domain.

pub fn author_id(&self) -> AuthorId

Returns this device’s authenticated endpoint identity.

pub fn domain_seed(&self) -> DomainSeed

Exports sensitive domain bootstrap material for a trusted device-add workflow.

pub fn domain_id(&self) -> DomainId

Returns this handle’s isolated security and replication domain.

pub fn attach_domain(&self, seed: &DomainSeed) -> Result<Self, DbError>

Attaches an independently encrypted domain to this device and returns its handle.

pub fn create_domain(&self, mode: ConsistencyMode) -> Result<Self, DbError>

Creates a capability-controlled domain owned by this device.

pub fn domain_descriptor(&self) -> Result<Option<DomainDescriptor>, DbError>

Returns the signed genesis descriptor for a controlled domain.

pub fn rotate_epoch( &self, revoked_subjects: &[AuthorId], ) -> Result<(Self, ControlTransition), DbError>

Advances the domain epoch at its current causal frontier and revokes endpoints.

pub fn rotate_epoch_with_controller( &self, revoked_subjects: &[AuthorId], next_controller: AuthorId, ) -> Result<(Self, ControlTransition), DbError>

Advances the epoch and designates the endpoint that must sign the following transition.

pub fn apply_epoch_rotation( &self, control: &ControlTransition, next_seed: &DomainSeed, ) -> Result<Self, DbError>

Applies signed control and its separately delivered endpoint-targeted epoch key.

pub fn issue_capability( &self, subject: AuthorId, permissions: PermissionSet, delegation_permissions: PermissionSet, valid_from_epoch: u64, valid_through_epoch: Option<u64>, ) -> Result<CapabilityCertificate, DbError>

Issues and installs a narrowed endpoint capability from this device’s active grant.

pub fn active_capability( &self, ) -> Result<Option<CapabilityCertificate>, DbError>

Returns this device’s active capability in the selected domain.

pub fn invite( &self, subject: AuthorId, permissions: PermissionSet, delegation_permissions: PermissionSet, valid_through_epoch: Option<u64>, ) -> Result<Invitation, DbError>

Issues a targeted signed invitation carrying the current epoch key and capability chain.

pub fn import_invitation( &self, invitation: &Invitation, ) -> Result<Self, DbError>

Imports a validated invitation only when it names this device endpoint.

pub fn import_ticket( &self, ticket: &InvitationTicket, secret: &InvitationSecret, ) -> Result<Self, DbError>

Decrypts an offline ticket for this endpoint and imports its domain authority.

pub fn domain(&self, domain_id: DomainId) -> Result<Self, DbError>

Opens a previously attached domain under the same device identity and local store.

pub fn domains(&self) -> Result<Vec<DomainId>, DbError>

Lists domains whose encrypted keys are available to this device.

pub fn set_device_group( &self, label: &str, members: &[AuthorId], ) -> Result<(), DbError>

Replaces a bounded local UX group; authorization remains endpoint-specific.

pub fn device_groups(&self) -> Result<Vec<DeviceGroup>, DbError>

Lists durable application-facing device groups for this domain.

pub async fn project<Record, PredicateFn>( &self, destination: &IrohDb, include: PredicateFn, ) -> Result<ProjectionReport, DbError>

where Record: IrohRecord, PredicateFn: FnMut(&Record) -> bool,

Copies selected current typed records into one independent destination commit.

pub fn trust_device(&self, author: AuthorId) -> Result<(), DbError>

Adds a device identity to the local authorization set.

pub async fn commit_envelopes(&self) -> Result<Vec<CommitEnvelope>, DbError>

Loads accepted immutable commit envelopes in deterministic content-hash order.

pub async fn accept_remote_commit( &self, authenticated_peer: AuthorId, envelope: CommitEnvelope, ) -> Result<RemoteApply, DbError>

Validates, CRDT-merges, and atomically accepts one commit from an authenticated endpoint.

pub async fn close(self) -> Result<(), DbError>

Flushes and shuts down the local blob actor for a clean same-process reopen.

pub async fn run_migrations(&self) -> Result<MigrationReport, DbError>

Resumes every registered transition across all locally attached domains.

impl IrohDb

pub async fn start_sync(&self) -> Result<SyncNode, DbError>

Starts a local iroh endpoint with sync and iroh-blobs protocol handlers.

impl IrohDb

pub fn operational_metrics(&self) -> Result<OperationalMetrics, DbError>

Returns a low-cardinality operational snapshot safe for metrics exporters.

pub async fn verify(&self) -> Result<VerificationReport, DbError>

Verifies content hashes, signatures, encryption, dependency presence, and rebuild equality.

pub async fn repair(&self) -> Result<VerificationReport, DbError>

Rebuilds typed materialized state in memory and swaps it in one metadata transaction.

pub async fn repair_indexes(&self) -> Result<VerificationReport, DbError>

Rewrites existing materialized/index tables atomically when application record types are absent.

impl IrohDb

pub async fn snapshot(&self) -> Result<Snapshot, DbError>

Captures canonical materialized state and frontier in a signed encrypted blob.

pub async fn install_snapshot(&self, snapshot: Snapshot) -> Result<(), DbError>

Verifies and atomically installs a local snapshot’s derived state.

pub async fn rebuild(&self) -> Result<[u8; 32], DbError>

Rebuilds all derived records and indexes from validated immutable commits.

pub fn state_root(&self) -> Result<[u8; 32], DbError>

Computes the canonical root of current materialized state.

Trait Implementations

impl Clone for IrohDb

fn clone(&self) -> IrohDb

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.