Struct CollectionStore

Source

pub struct CollectionStore { /* private fields */ }

Expand description

Persists immutable manifests as pinned blobs and mutable heads in iroh-docs.

Implementations§

Source §

impl CollectionStore

Source

pub const fn new( doc: Doc, author: AuthorId, blobs: BlobStore, docs: DocsEngine, ) -> Self

Source

pub async fn publish( &self, manifest: &CollectionManifest, sequence: u64, ) -> Result<CollectionHead>

§Errors

Returns an error if manifest storage or head publication fails.

Source

pub async fn head(&self, collection_id: Uuid) -> Result<Option<CollectionHead>>

Read the mutable collection head stored in the document.

§Errors

Returns an error if the head cannot be read or decoded.

Source

pub async fn load(&self, hash: Hash) -> Result<CollectionManifest>

§Errors

Returns an error if the manifest blob cannot be read or decoded.

Trait Implementations§

Source §

impl Clone for CollectionStore

Source §

fn clone(&self) -> CollectionStore

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

Auto Trait Implementations§

§

impl UnsafeUnpin for CollectionStore

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source §

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source §

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source §

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DynClone for T
where T: Clone,

Source §

fn __clone_box(&self, _: Private) -> *mut ()

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

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

Source §

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

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 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 §