Skip to main content

VoidContext

Struct VoidContext 

Source
pub struct VoidContext {
    pub paths: RepoPaths,
    pub crypto: CryptoContext,
    pub repo: RepoMeta,
    pub seal: SealConfig,
    pub network: NetworkConfig,
    pub user: UserConfig,
}
Expand description

Application-level DI container for a single CLI invocation.

Created once (via build_void_context in the CLI crate) and threaded through the call stack. Subsystems can be borrowed independently.

Fields§

§paths: RepoPaths

Where the repository lives on disk.

§crypto: CryptoContext

Encryption vault + identity keys.

§repo: RepoMeta

Repository identity (id, name, secret).

§seal: SealConfig

Compression / shard sizing settings.

§network: NetworkConfig

Transport configuration (IPFS, Tor, remotes).

§user: UserConfig

Author identity (name, email).

Implementations§

Source§

impl VoidContext

Source

pub fn open_store(&self) -> Result<FsStore>

Open the object store for this repository.

Source

pub fn fetch_object<B: EncryptedBlob>( &self, remote: &dyn RemoteStore, cid: &VoidCid, ) -> Result<B>

Fetch a typed encrypted blob, local-first with remote fallback.

Checks the local object store first. On miss, fetches raw bytes from the remote (which handles CID verification), stores locally, and wraps.

Source

pub fn push_object<B: EncryptedBlob>( &self, remote: &dyn RemoteStore, blob: &B, ) -> Result<VoidCid>

Push a typed encrypted blob to a remote store.

Extracts raw bytes, pushes via remote (which handles CID verification).

Source

pub fn has_identity(&self) -> bool

Check if a signing identity is loaded.

Source

pub fn nostr_pubkey(&self) -> Option<&NostrPubKey>

Get the nostr public key (if identity was loaded with one).

Source

pub fn resolve_head(&self) -> Result<Option<CommitCid>>

Resolve HEAD to a commit CID (handles workspace-split correctly).

Source

pub fn decrypt(&self, ciphertext: &[u8], aad: &[u8]) -> Result<Vec<u8>>

Decrypt a blob using the vault.

Source

pub fn decrypt_raw(&self, ciphertext: &[u8], aad: &[u8]) -> Result<Vec<u8>>

Decrypt a blob into raw bytes.

Source

pub fn open_commit( &self, blob: &EncryptedCommit, ) -> Result<(CommitPlaintext, CommitReader)>

Decrypt a commit blob and return a CommitReader for child objects.

Source

pub fn open_and_parse_commit( &self, blob: &EncryptedCommit, ) -> Result<(Commit, CommitReader)>

Decrypt a commit blob, then parse it into (Commit, CommitReader).

Source

pub fn load_commit( &self, store: &impl ObjectStoreExt, commit_cid: &VoidCid, ) -> Result<(Commit, CommitReader)>

Load a commit by CID from the store, decrypt, and parse.

Collapses the common store.get → open_with_vault → parse_commit chain into a single call.

Source

pub fn load_commit_with_metadata( &self, store: &impl ObjectStoreExt, commit_cid: &VoidCid, ) -> Result<(Commit, MetadataBundle, CommitReader)>

Load a commit and its metadata by CID from the store.

Collapses the full store.get → decrypt commit → parse → get metadata → decrypt metadata chain into a single call.

Source

pub fn load_manifest( &self, store: &impl ObjectStoreExt, commit: &Commit, reader: &CommitReader, ) -> Result<Option<TreeManifest>>

Load a TreeManifest from a commit.

Returns None if the commit has no manifest_cid (older commits).

Source

pub fn read_file_from_commit( &self, store: &impl ObjectStoreExt, commit: &Commit, reader: &CommitReader, ancestor_keys: &[ContentKey], path: &str, ) -> Result<FileContent>

Read a file from a commit using the TreeManifest.

Loads the manifest, looks up the file entry, fetches and decrypts the shard, decompresses the body, and extracts the file content. Handles chunked files (shard_count > 1) by fetching all chunk shards and concatenating their content.

Source

pub fn decrypt_parse<T>(&self, ciphertext: &[u8], aad: &[u8]) -> Result<T>

Decrypt and parse a CBOR-serialized type.

Source§

impl VoidContext

Source

pub fn headless( void_dir: impl AsRef<Path>, vault: Arc<KeyVault>, epoch: u64, ) -> Result<Self>

Create a context for headless / network-only operations.

Sets root to the parent of void_dir (or void_dir itself if no parent). Use when no workspace root is available (clone, push, pull, repair, etc.).

Source

pub fn with_workspace( root: impl AsRef<Path>, void_dir: impl AsRef<Path>, workspace_dir: impl AsRef<Path>, vault: Arc<KeyVault>, epoch: u64, ) -> Result<Self>

Create a context for a linked worktree.

workspace_dir is the per-workspace state directory (e.g. .void/worktrees/{name}/) where HEAD, index, staged blobs and merge state live. Shared state (objects, refs, config, keys) is still read from void_dir.

Trait Implementations§

Source§

impl Clone for VoidContext

Source§

fn clone(&self) -> VoidContext

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for VoidContext

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more