Struct BlockBuilder

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

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.