Struct iroh_bytes::store::readonly_mem::Store

pub struct Store(/* private fields */);

A readonly in memory database for iroh-bytes.

This is basically just a HashMap, so it does not allow for any modifications unless you have a mutable reference to it.

It is therefore useful mostly for testing and sharing static data.

Implementations

impl Store

pub fn new( entries: impl IntoIterator<Item = (impl Into<String>, impl AsRef<[u8]>)> ) -> (Self, BTreeMap<String, Hash>)

Create a new Store from a sequence of entries.

Returns the database and a map of names to computed blake3 hashes. In case of duplicate names, the last entry is used.

pub fn insert(&mut self, data: impl AsRef<[u8]>) -> Hash

Insert a new entry into the database, and return the hash of the entry.

If the database was shared before, this will make a copy.

pub fn insert_many( &mut self, items: impl IntoIterator<Item = impl AsRef<[u8]>> ) -> Option<Hash>

Insert multiple entries into the database, and return the hash of the last entry.

pub fn get(&self, hash: &Hash) -> Option<Bytes>

Get the bytes associated with a hash, if they exist.

Trait Implementations

impl Clone for Store

fn clone(&self) -> Store

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Store

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

Formats the value using the given formatter.

impl Default for Store

fn default() -> Store

Returns the “default value” for a type.

impl<K, V> FromIterator<(K, V)> for Store

where K: Into<String>, V: AsRef<[u8]>,

fn from_iter<T: IntoIterator<Item = (K, V)>>(iter: T) -> Self

Creates a value from an iterator.

impl Map for Store

type Outboard = PreOrderMemOutboard<Bytes>

The outboard type. This can be an in memory outboard or an outboard that retrieves the data asynchronously from a remote database.

type DataReader = Bytes

The reader type.

type Entry = Entry

The entry type. An entry is a cheaply cloneable handle that can be used to open readers for both the data and the outboard

fn get(&self, hash: &Hash) -> Option<Self::Entry>

Get an entry for a hash.

impl MapEntry<Store> for Entry

fn hash(&self) -> Hash

The hash of the entry.

fn size(&self) -> u64

The size of the entry.

fn available_ranges(&self) -> BoxFuture<'_, Result<ChunkRanges>>

Compute the available ranges.

fn outboard(&self) -> BoxFuture<'_, Result<PreOrderMemOutboard<Bytes>>>

A future that resolves to a reader that can be used to read the outboard

fn data_reader(&self) -> BoxFuture<'_, Result<Bytes>>

A future that resolves to a reader that can be used to read the data

fn is_complete(&self) -> bool

Returns true if the entry is complete.

impl MapEntry<Store> for PartialEntry

fn hash(&self) -> Hash

The hash of the entry.

fn available_ranges(&self) -> BoxFuture<'_, Result<ChunkRanges>>

Compute the available ranges.

fn size(&self) -> u64

The size of the entry.

fn outboard(&self) -> BoxFuture<'_, Result<PreOrderMemOutboard<Bytes>>>

A future that resolves to a reader that can be used to read the outboard

fn data_reader(&self) -> BoxFuture<'_, Result<Bytes>>

A future that resolves to a reader that can be used to read the data

fn is_complete(&self) -> bool

Returns true if the entry is complete.

impl PartialMap for Store

type OutboardMut = PreOrderOutboard<BytesMut>

The outboard type to write data to the partial entry.

type DataWriter = BytesMut

The writer type to write data to the partial entry.

type PartialEntry = PartialEntry

A partial entry. This is an entry that is writeable and possibly incomplete.

fn get_or_create_partial(&self, _hash: Hash, _size: u64) -> Result<PartialEntry>

Get an existing partial entry, or create a new one.

fn entry_status(&self, hash: &Hash) -> EntryStatus

Find out if the data behind a hash is complete, partial, or not present.

fn get_possibly_partial(&self, hash: &Hash) -> PossiblyPartialEntry<Self>

Get an existing entry.

fn insert_complete(&self, _entry: PartialEntry) -> BoxFuture<'_, Result<()>>

Upgrade a partial entry to a complete entry.

impl PartialMapEntry<Store> for PartialEntry

fn outboard_mut( &self ) -> BoxFuture<'_, Result<<Store as PartialMap>::OutboardMut>>

A future that resolves to an writeable outboard

fn data_writer( &self ) -> BoxFuture<'_, Result<<Store as PartialMap>::DataWriter>>

A future that resolves to a writer that can be used to write the data

impl ReadableStore for Store

fn blobs(&self) -> Box<dyn Iterator<Item = Hash> + Send + Sync + 'static>

list all blobs in the database. This should include collections, since collections are blobs and can be requested as blobs.

fn tags( &self ) -> Box<dyn Iterator<Item = (Tag, HashAndFormat)> + Send + Sync + 'static>

list all tags (collections or other explicitly added things) in the database

fn temp_tags( &self ) -> Box<dyn Iterator<Item = HashAndFormat> + Send + Sync + 'static>

Temp tags

fn validate( &self, _tx: Sender<ValidateProgress> ) -> BoxFuture<'static, Result<()>>

Validate the database

fn export( &self, hash: Hash, target: PathBuf, mode: ExportMode, progress: impl Fn(u64) -> Result<()> + Send + Sync + 'static ) -> BoxFuture<'_, Result<()>>

This trait method extracts a file to a local path.

fn partial_blobs( &self ) -> Box<dyn Iterator<Item = Hash> + Send + Sync + 'static>

list partial blobs in the database

impl Store for Store

fn import_bytes( &self, bytes: Bytes, format: BlobFormat ) -> BoxFuture<'_, Result<TempTag>>

import a byte slice

fn import_file( &self, data: PathBuf, mode: ImportMode, format: BlobFormat, progress: impl ProgressSender<Msg = ImportProgress> + IdGenerator ) -> BoxFuture<'_, Result<(TempTag, u64)>>

This trait method imports a file from a local path.

fn import_stream( &self, data: impl Stream<Item = Result<Bytes>> + Unpin + Send, format: BlobFormat, progress: impl ProgressSender<Msg = ImportProgress> + IdGenerator ) -> BoxFuture<'_, Result<(TempTag, u64)>>

Import data from a stream of bytes.

fn clear_live(&self)

Clear the live set.

fn set_tag( &self, _name: Tag, _hash: Option<HashAndFormat> ) -> BoxFuture<'_, Result<()>>

Set a tag

fn create_tag(&self, _hash: HashAndFormat) -> BoxFuture<'_, Result<Tag>>

Create a new tag

fn temp_tag(&self, inner: HashAndFormat) -> TempTag

Create a temporary pin for this store

fn add_live(&self, _live: impl IntoIterator<Item = Hash>)

Add the given hashes to the live set.

fn delete(&self, _hash: &Hash) -> BoxFuture<'_, Result<()>>

physically delete the given hash from the store.

fn is_live(&self, _hash: &Hash) -> bool

True if the given hash is live.

fn import_reader( &self, data: impl AsyncRead + Send + Unpin + 'static, format: BlobFormat, progress: impl ProgressSender<Msg = ImportProgress> + IdGenerator ) -> BoxFuture<'_, Result<(TempTag, u64)>>

Import data from an async byte reader.

fn gc_mark<'a>( &'a self, extra_roots: impl IntoIterator<Item = Result<HashAndFormat>> + 'a ) -> LocalBoxStream<'a, GcMarkEvent>

Traverse all roots recursively and mark them as live.

fn gc_sweep(&self) -> LocalBoxStream<'_, GcSweepEvent>

Remove all blobs that are not marked as live.