Module rust_ipfs::repo

Storage implementation(s) backing the crate::Ipfs.

Modules

fs

Persistent fs backed repo.

kv

mem

Volatile memory backed repo

Structs

Repo

Describes a repo.

RepoCid

A wrapper for Cid that has a Multihash-based equality check.

RepoOptions

Configuration for a repo.

Enums

BlockPut

Describes the outcome of BlockStore::put_block.

BlockRm

Describes the outcome of BlockStore::remove.

BlockRmError

Describes the error variants for BlockStore::remove.

Column

LockError

Errors variants describing the possible failures for Lock::try_exclusive.

PinKind

PinKind is more specific pin description for writing purposes. Implements PartialEq<&PinMode>. Generic over Borrow<Cid> to allow storing both reference and owned value of Cid.

PinMode

PinMode is the description of pin type for quering purposes.

RepoEvent

Events used to communicate to the swarm on repo changes.

Traits

BlockStore

This API is being discussed and evolved, which will likely lead to breakage.

DataStore

Generic layer of abstraction for a key-value data store.

Lock

A trait for describing repository locking.

PinStore

RepoTypes

Consolidates BlockStore and DataStore into a representation of storage.

Functions

create_repo

Convenience for creating a new Repo from the RepoOptions.