Struct rust_ipfs::dag::IpldDag

pub struct IpldDag<Types: RepoTypes> { /* private fields */ }

ipfs.dag interface providing wrapper around Ipfs.

Implementations

impl<Types: RepoTypes> IpldDag<Types>

pub fn new(ipfs: Ipfs<Types>) -> Self

Creates a new IpldDag for DAG operations.

pub async fn put(
    &self,
    codec: IpldCodec,
    data: Ipld,
    opt: Option<DagOpt>
) -> Result<Cid, Error>

Returns the Cid of a newly inserted block.

The block is created from the data, encoded with the codec and inserted into the repo.

pub async fn get(&self, path: IpfsPath) -> Result<Ipld, ResolveError>

Resolves a Cid-rooted path to a document “node.”

Returns the resolved node as Ipld.

pub async fn resolve(
    &self,
    path: IpfsPath,
    follow_links: bool
) -> Result<(ResolvedNode, SlashedPath), ResolveError>

Resolves a Cid-rooted path to a document “node.”

The return value has two kinds of meanings depending on whether links should be followed or not: when following links, the second returned value will be the path inside the last document; when not following links, the second returned value will be the unmatched or “remaining” path.

Regardless of the follow_links option, HAMT-sharded directories will be resolved through as a “single step” in the given IpfsPath.

Returns a node and the remaining path or the path inside the last document.

Trait Implementations

impl<Types: Clone + RepoTypes> Clone for IpldDag<Types>

fn clone(&self) -> IpldDag<Types>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Types: Debug + RepoTypes> Debug for IpldDag<Types>

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

Formats the value using the given formatter.