Struct ipld_block_builder::BlockBuilder

pub struct BlockBuilder<S, C> { /* fields omitted */ }

Generic block builder for creating blocks.

Implementations

impl<S, C> BlockBuilder<S, C>

pub fn new(store: S, codec: C) -> Self

Creates a builder for public blocks.

pub fn visibility(&self) -> Visibility

Gets the visibility of the builder.

pub fn store(&self) -> &S

Gets the store of the builder.

pub fn codec(&self) -> &C

Gets the codec of the builder.

impl<S, C: Encrypted> BlockBuilder<S, C>

pub fn new_private(store: S, codec: C) -> Self

Creates a builder for private blocks.

impl<S: ReadonlyStore, C: Decoder> BlockBuilder<S, C>

pub async fn get<'_, '_, D: Decode<C::Codec>>(
    &'_ self,
    cid: &'_ Cid
) -> Result<D>

Returns the decoded block with cid.

impl<S: ReadonlyStore, C: IpldDecoder> BlockBuilder<S, C>

pub async fn get_ipld<'_, '_>(&'_ self, cid: &'_ Cid) -> Result<Ipld>

Returns the ipld representation of a block with cid.

pub async fn get_path<'_, '_, '_>(
    &'_ self,
    path: &'_ DagPath<'_>
) -> Result<Ipld>

Resolves a path recursively and returns the ipld.

impl<S: Store, C: Encoder + Clone> BlockBuilder<S, C>

pub fn create_batch(&self) -> Batch<C>

Creates a new batch.

pub fn create_batch_with_capacity(&self, capacity: usize) -> Batch<C>

Creates a new batch with capacity.

pub async fn insert<'_, '_, E: Encode<C::Codec>>(
    &'_ self,
    e: &'_ E
) -> Result<Cid>

Encodes and inserts a block into the store.

pub async fn insert_batch<'_, T>(&'_ self, batch: Batch<T>) -> Result<Cid>

Inserts a batch of blocks atomically pinning the last one.

impl<S: Store, C> BlockBuilder<S, C>

pub async fn flush<'_>(&'_ self) -> Result<()>

Flushes the store to disk.

pub async fn unpin<'_, '_>(&'_ self, cid: &'_ Cid) -> Result<()>

Unpins a block from the store marking it ready for garbage collection.

impl<S: MultiUserStore, C> BlockBuilder<S, C>

pub async fn pin<'_, '_, '_>(
    &'_ self,
    cid: &'_ Cid,
    path: &'_ Path
) -> Result<()>

Pins a block in the store.

impl<S: AliasStore, C> BlockBuilder<S, C>

pub async fn alias<'_, '_, '_>(
    &'_ self,
    alias: &'_ [u8],
    cid: &'_ Cid
) -> Result<()>

Creates an alias for a cid.

pub async fn unalias<'_, '_>(&'_ self, alias: &'_ [u8]) -> Result<()>

Removes an alias.

pub async fn resolve<'_, '_>(&'_ self, alias: &'_ [u8]) -> Result<Option<Cid>>

Resolves an alias.