Skip to main content

FileNodeStore

Struct FileNodeStore 

Source
pub struct FileNodeStore { /* private fields */ }
Expand description

Durable filesystem node store using content-addressed object layout.

Nodes are stored under nodes/sha256/aa/bb/<cid-hex> below the configured root. Hints are stored under hints/<namespace-hex>/<key-hex>, and named roots are stored under roots/<name-hex>. Node reads and writes verify that bytes hash to the CID key.

Implementations§

Source§

impl FileNodeStore

Source

pub fn open(root: impl Into<PathBuf>) -> Result<Self, FileNodeStoreError>

Open or create a filesystem node store rooted at root.

Source

pub fn root(&self) -> &Path

Return the root directory for this store.

Source

pub fn node_namespace_dir(&self) -> PathBuf

Return the namespace directory containing immutable node objects.

Source

pub fn hint_namespace_dir(&self) -> PathBuf

Return the namespace directory containing optional performance hints.

Source

pub fn root_namespace_dir(&self) -> PathBuf

Return the namespace directory containing named root manifests.

Source

pub fn path_for_cid(&self, cid: &Cid) -> PathBuf

Return the filesystem path for a content-addressed node.

Trait Implementations§

Source§

impl Clone for FileNodeStore

Source§

fn clone(&self) -> FileNodeStore

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FileNodeStore

Source§

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

Formats the value using the given formatter. Read more
Source§

impl ManifestStore for FileNodeStore

Source§

type Error = FileNodeStoreError

Error type for manifest operations.
Source§

fn get_root(&self, name: &[u8]) -> Result<Option<RootManifest>, Self::Error>

Load a named root manifest.
Source§

fn put_root( &self, name: &[u8], manifest: &RootManifest, ) -> Result<(), Self::Error>

Unconditionally insert or replace a named root manifest.
Source§

fn delete_root(&self, name: &[u8]) -> Result<(), Self::Error>

Delete a named root manifest. Deleting a missing name is not an error.
Source§

fn compare_and_swap_root( &self, name: &[u8], expected: Option<&RootManifest>, new: Option<&RootManifest>, ) -> Result<ManifestUpdate, Self::Error>

Atomically update a named root if the current manifest matches expected. Read more
Source§

impl ManifestStoreScan for FileNodeStore

Source§

fn list_roots(&self) -> Result<Vec<NamedRootManifest>, Self::Error>

List all durable named root manifests.
Source§

impl NodeStoreScan for FileNodeStore

Source§

type Error = FileNodeStoreError

Error type for scan operations.
Source§

fn list_node_cids(&self) -> Result<Vec<Cid>, Self::Error>

List all content-addressed node CIDs currently known to the store. Read more
Source§

impl Store for FileNodeStore

Source§

type Error = FileNodeStoreError

Error type for storage operations
Source§

fn get(&self, key: &[u8]) -> Result<Option<Vec<u8>>, Self::Error>

Get value by key Read more
Source§

fn put(&self, key: &[u8], value: &[u8]) -> Result<(), Self::Error>

Store key-value pair Read more
Source§

fn delete(&self, key: &[u8]) -> Result<(), Self::Error>

Delete key Read more
Source§

fn batch(&self, ops: &[BatchOp<'_>]) -> Result<(), Self::Error>

Batch write operations (atomic if supported by backend) Read more
Source§

fn batch_get( &self, keys: &[&[u8]], ) -> Result<HashMap<Vec<u8>, Vec<u8>>, Self::Error>

Retrieve multiple keys in a single operation Read more
Source§

fn batch_get_ordered( &self, keys: &[&[u8]], ) -> Result<Vec<Option<Vec<u8>>>, Self::Error>

Retrieve multiple keys in a single operation with order preservation Read more
Source§

fn batch_get_ordered_unique( &self, keys: &[&[u8]], ) -> Result<Vec<Option<Vec<u8>>>, Self::Error>

Retrieve unique keys in input order. Read more
Source§

fn batch_put(&self, entries: &[(&[u8], &[u8])]) -> Result<(), Self::Error>

Store multiple key-value pairs in a single operation Read more
Source§

fn supports_hints(&self) -> bool

Whether this store persists performance hints.
Source§

fn get_hint( &self, namespace: &[u8], key: &[u8], ) -> Result<Option<Vec<u8>>, Self::Error>

Retrieve an optional performance hint for a logical namespace and key. Read more
Source§

fn put_hint( &self, namespace: &[u8], key: &[u8], value: &[u8], ) -> Result<(), Self::Error>

Persist an optional performance hint for a logical namespace and key. Read more
Source§

fn batch_put_with_hint( &self, entries: &[(&[u8], &[u8])], namespace: &[u8], key: &[u8], value: &[u8], ) -> Result<(), Self::Error>

Store content-addressed nodes and one hint atomically when supported.
Source§

fn prefers_batch_reads(&self) -> bool

Whether this store has an efficient batched-read implementation. Read more
Source§

impl TransactionalStore for FileNodeStore

Source§

fn supports_transactions(&self) -> bool

Whether this backend can atomically commit staged nodes and roots.
Source§

fn commit_transaction( &self, node_writes: &[TransactionNodeWrite], root_conditions: &[RootCondition], root_writes: &[RootWrite], ) -> Result<TransactionUpdate, Error>

Atomically validate root conditions, write nodes, and apply root writes.

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, 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.