Struct iroh_blobs::format::collection::Collection

pub struct Collection { /* private fields */ }

A collection of blobs

Note that the format is subject to change.

Implementations

impl Collection

pub const HEADER: &'static [u8; 13] = b"CollectionV0."

The header for the collection format.

This is the start of the metadata blob.

pub fn to_blobs(&self) -> impl DoubleEndedIterator<Item = Bytes>

Convert the collection to an iterator of blobs, with the last being the root blob.

To persist the collection, write all the blobs to storage, and use the hash of the last blob as the collection hash.

pub async fn read_fsm( fsm_at_start_root: AtStartRoot ) -> Result<(EndBlobNext, HashSeq, Collection)>

Read the collection from a get fsm.

Returns the fsm at the start of the first child blob (if any), the links array, and the collection.

pub async fn read_fsm_all( fsm_at_start_root: AtStartRoot ) -> Result<(Collection, BTreeMap<u64, Bytes>, Stats)>

Read the collection and all it’s children from a get fsm.

Returns the collection, a map from blob offsets to bytes, and the stats.

pub async fn load(root: Hash, store: &impl SimpleStore) -> Result<Self>

Create a new collection from a hash sequence and metadata.

pub async fn load_db<D>(db: &D, root: &Hash) -> Result<Self>

where D: Map,

Load a collection from a store given a root hash

This assumes that both the links and the metadata of the collection is stored in the store. It does not require that all child blobs are stored in the store.

pub async fn store<D>(self, db: &D) -> Result<TempTag>

where D: Store,

Store a collection in a store. returns the root hash of the collection as a TempTag.

pub fn iter(&self) -> impl Iterator<Item = &(String, Hash)>

Iterate over the blobs in this collection

pub fn len(&self) -> usize

Get the number of blobs in this collection

pub fn is_empty(&self) -> bool

Check if this collection is empty

pub fn push(&mut self, name: String, hash: Hash)

Add the given blob to the collection.

Trait Implementations

impl Clone for Collection

fn clone(&self) -> Collection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Collection

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

Formats the value using the given formatter.

impl Default for Collection

fn default() -> Collection

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Collection

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<K, V> Extend<(K, V)> for Collection

where K: Into<String>, V: Into<Hash>,

fn extend<T: IntoIterator<Item = (K, V)>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

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

where K: Into<String>, V: Into<Hash>,

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

Creates a value from an iterator.

impl Index<usize> for Collection

type Output = (String, Hash)

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IntoIterator for Collection

type Item = (String, Hash)

The type of the elements being iterated over.

type IntoIter = IntoIter<<Collection as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Collection

fn eq(&self, other: &Collection) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Collection

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Collection