Struct rust_ipfs::repo::Repo

pub struct Repo<TRepoTypes: RepoTypes> { /* private fields */ }

Describes a repo.

Consolidates a blockstore, a datastore and a subscription registry.

Implementations

impl<TRepoTypes: RepoTypes> Repo<TRepoTypes>

pub fn new(options: RepoOptions) -> (Self, Receiver<RepoEvent>)

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 async fn init(&self) -> Result<(), Error>

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

pub async fn put_block(&self, block: Block) -> Result<(Cid, BlockPut), Error>

Puts a block into the block store.

pub async fn get_block(&self, cid: &Cid) -> Result<Block, Error>

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

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

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

pub async fn list_blocks(&self) -> Result<Vec<Cid>, Error>

Lists the blocks in the blockstore.

pub async fn remove_block(&self, cid: &Cid) -> Result<Cid, Error>

Remove block from the block store.

pub async fn get_ipns(&self, ipns: &PeerId) -> Result<Option<IpfsPath>, Error>

Get an ipld path from the datastore.

pub async fn put_ipns(&self, ipns: &PeerId, path: &IpfsPath) -> Result<(), Error>

Put an ipld path into the datastore.

pub async fn remove_ipns(&self, ipns: &PeerId) -> Result<(), Error>

Remove an ipld path from the datastore.

pub async fn insert_direct_pin(&self, cid: &Cid) -> Result<(), Error>

Inserts a direct pin for a Cid.

pub async fn insert_recursive_pin(
    &self,
    cid: &Cid,
    refs: BoxStream<'_, Result<Cid, IpldRefsError>>
) -> Result<(), Error>

Inserts a recursive pin for a Cid.

pub async fn remove_direct_pin(&self, cid: &Cid) -> Result<(), Error>

Removes a direct pin for a Cid.

pub async fn remove_recursive_pin(
    &self,
    cid: &Cid,
    refs: BoxStream<'_, Result<Cid, IpldRefsError>>
) -> Result<(), Error>

Removes a recursive pin for a Cid.

pub async fn cleanup(&self) -> Result<Vec<Cid>, Error>

Function to perform a basic cleanup of unpinned blocks

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

Checks if a Cid is pinned.

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

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

Trait Implementations

impl<TRepoTypes: Debug + RepoTypes> Debug for Repo<TRepoTypes>where
    TRepoTypes::TBlockStore: Debug,
    TRepoTypes::TDataStore: Debug,
    TRepoTypes::TLock: Debug,

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

Formats the value using the given formatter.