Skip to main content

FsIndexStore

Struct FsIndexStore 

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

The reference index substrate: one file per node under <root>/index.

Layout: <root>/index/<aa>/<bb>/<64-hex> where aa/bb are the first two bytes of the id in hex. Writes are atomic (tmp -> fsync -> rename); reads are hash-verified by FsIndexStore::get.

Implementations§

Source§

impl FsIndexStore

Source

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

Open (creating if needed) an index store rooted at root, using root/index, with a fresh, private I/O counter set.

Source

pub fn open_with_io(root: impl AsRef<Path>, io: IoCounters) -> Result<Self>

Open an index store that accounts every node read against io.

Source

pub fn put(&mut self, canonical: &[u8]) -> Result<NodeId>

Store one canonical node, returning its content id. Idempotent and atomic.

Source

pub fn get(&self, id: &NodeId) -> Result<Vec<u8>>

Fetch a node, verifying NodeId::of_node(bytes) == id.

Source

pub fn contains(&self, id: &NodeId) -> Result<bool>

Whether a node id is present.

Source

pub fn list_ids(&self) -> Result<Vec<NodeId>>

Every node id physically present in the index namespace.

Used to tell a genuinely new node from one a previous build already wrote (the index is content-addressed, so an unchanged node has an unchanged id and is never rewritten).

Source

pub fn count(&self) -> Result<u64>

Number of stored nodes.

Trait Implementations§

Source§

impl Debug for FsIndexStore

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> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.