Struct Repo

pub struct Repo { /* private fields */ }

Describes a repo.

Consolidates a blockstore, a datastore and a subscription registry.

Implementations

impl Repo

pub fn new(repo_type: &mut StorageType) -> Self

pub fn new_raw( block_store: Box<dyn BlockStore>, data_store: Box<dyn DataStore>, lockfile: Box<dyn Lock>, ) -> Self

pub fn new_fs(path: impl AsRef<Path>) -> Self

pub fn new_memory() -> Self

pub fn set_max_storage_size(&self, size: usize)

pub fn max_storage_size(&self) -> usize

pub async fn migrate(&self, repo: &Self) -> Result<(), Error>

pub fn shutdown(&self)

Shutdowns the repo, cancelling any pending subscriptions; Likely going away after some refactoring, see notes on crate::Ipfs::exit_daemon.

pub fn is_online(&self) -> bool

pub async fn init(&self) -> Result<(), Error>

pub fn put_block<'a>(&self, block: &'a Block) -> RepoPutBlock<'a>

Puts a block into the block store.

pub fn get_block<C: Borrow<Cid>>(&self, cid: C) -> RepoGetBlock

Retrives a block from the block store, or starts fetching it from the network and awaits until it has been fetched.

pub fn get_blocks( &self, cids: impl IntoIterator<Item = impl Borrow<Cid>>, ) -> RepoGetBlocks

Retrives a set of blocks from the block store, or starts fetching them from the network and awaits until it has been fetched.

pub async fn get_blocks_size( &self, cids: &[Cid], ) -> Result<Option<usize>, Error>

Get the size of listed blocks

pub async fn get_total_size(&self) -> Result<usize, Error>

Get the total size of the block store

pub async fn get_block_now<C: Borrow<Cid>>( &self, cid: C, ) -> Result<Option<Block>, Error>

Retrieves a block from the block store if it’s available locally.

pub async fn contains<C: Borrow<Cid>>(&self, cid: C) -> Result<bool, Error>

Check to determine if blockstore contain a block

pub async fn list_blocks(&self) -> BoxStream<'static, Cid>

Lists the blocks in the blockstore.

pub async fn remove_block<C: Borrow<Cid>>( &self, cid: C, recursive: bool, ) -> Result<Vec<Cid>, Error>

Remove block from the block store.

pub fn pin<C: Borrow<Cid>>(&self, cid: C) -> RepoInsertPin

Pins a given Cid recursively or directly (non-recursively).

Pins on a block are additive in sense that a previously directly (non-recursively) pinned can be made recursive, but removing the recursive pin on the block removes also the direct pin as well.

Pinning a Cid recursively (for supported dag-protobuf and dag-cbor) will walk its references and pin the references indirectly. When a Cid is pinned indirectly it will keep its previous direct or recursive pin and be indirect in addition.

Recursively pinned Cids cannot be re-pinned non-recursively but non-recursively pinned Cids can be “upgraded to” being recursively pinned.

pub fn remove_pin<C: Borrow<Cid>>(&self, cid: C) -> RepoRemovePin

Unpins a given Cid recursively or only directly.

Recursively unpinning a previously only directly pinned Cid will remove the direct pin.

Unpinning an indirectly pinned Cid is not possible other than through its recursively pinned tree roots.

pub fn fetch<C: Borrow<Cid>>(&self, cid: C) -> RepoFetch

pub async fn is_pinned<C: Borrow<Cid>>(&self, cid: C) -> Result<bool, Error>

Checks if a Cid is pinned.

pub async fn list_pins( &self, mode: impl Into<Option<PinMode>>, ) -> BoxStream<'static, Result<(Cid, PinMode), Error>>

pub async fn query_pins( &self, cids: Vec<Cid>, requirement: impl Into<Option<PinMode>>, ) -> Result<Vec<(Cid, PinKind<Cid>)>, Error>

impl Repo

pub async fn gc_guard(&self) -> GCGuard<'_>

Hold a guard to prevent GC from running until this guard has dropped Note: Until this guard drops, the GC task, if enabled, would not perform any cleanup. If the GC task is running, this guard will await until GC finishes

pub fn data_store(&self) -> &dyn DataStore

Trait Implementations

impl Clone for Repo

fn clone(&self) -> Repo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Repo

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

Formats the value using the given formatter.

impl From<Repo> for IpldDag

fn from(repo: Repo) -> Self

Converts to this type from the input type.