ipfs::ipld::DagNode Class Reference

A block, an IPNS record, etc. More...

#include <include/ipfs_client/ipld/dag_node.h>

Inheritance diagram for ipfs::ipld::DagNode:

Collaboration diagram for ipfs::ipld::DagNode:

Public Member Functions
ResolveResult	Resolve (ResolutionState &params)
virtual NodePtr	rooted ()
virtual NodePtr	deroot ()
virtual DnsLinkName const *	as_dnslink () const
virtual DirShard *	as_hamt ()
virtual IpnsName const *	as_ipns () const
virtual bool	expired () const
virtual bool	PreferOver (DagNode const &another) const
void	set_api (std::shared_ptr< Client > api)
void	source (BlockSource src)

Static Public Member Functions
static NodePtr	fromBytes (std::shared_ptr< Client > const &api, Cid const &, ByteView bytes)
static NodePtr	fromBytes (std::shared_ptr< Client > const &api, Cid const &, std::string_view bytes)
static NodePtr	fromBlock (PbDag const &)

Protected Member Functions
ResolveResult	CallChild (ResolutionState &)
	As before, but it might be possible to create on the fly if not known.
ResolveResult	CallChild (ResolutionState &, std::function< NodePtr(std::string_view)> gen_child)
ResolveResult	CallChild (ResolutionState &, std::string_view link_key)
	Add the link if not present, then CallChild(ResolutionState)
ResolveResult	CallChild (ResolutionState &, std::string_view link_key, std::string_view block_key)

Protected Attributes
std::vector< std::pair< std::string, Link > >	links_
std::shared_ptr< Client >	api_

Detailed Description

A block, an IPNS record, etc.

Member Function Documentation

CallChild()

auto Node::CallChild ( ResolutionState &  state, std::function< NodePtr(std::string_view)>  gen_child  )

protected

When the child's name is not the next element in the path, but it must be known about. e.g. index.html for a path ending in a directory

deroot()

auto Node::deroot ( )

virtual

Returns

*this if it's not a Root, otherwise its child

expired()

auto Node::expired ( ) const

virtual

Returns

Whether the node should be considered expired.

Note

immutable data never expires

Reimplemented in ipfs::ipld::DnsLinkName, and ipfs::ipld::IpnsName.

PreferOver()

auto Node::PreferOver ( DagNode const &  another ) const

virtual

Returns

Whether this is a "better"/more-up-to-date replacement

Parameters

another

The node to compare to.

Resolve()

auto Node::Resolve

(

ResolutionState &

params

)

Query the DAG

Parameters

params

Information about what you're looking for

Returns

The data needed or how to get it or some additional info needed before asking again.

rooted()

auto Node::rooted ( )

virtual

Get a root node that is logically this node

Returns

this iff this is of type ipfs::ipld::Root Otherwise a Root that has this as a child.

set_api()

void Node::set_api

(

std::shared_ptr< Client >

api

)

Provide the Client API to be used in DAG operations

Parameters

api	Shared pointer to API for the context being run in

Member Data Documentation

api_

std::shared_ptr<Client> ipfs::ipld::DagNode::api_

protected

When the next path element is what's needed, and it should already be a link known about...

links_

std::vector<std::pair<std::string, Link> > ipfs::ipld::DagNode::links_

protected

The child nodes of this node, possibly not yet fetched.

Note

In some cases the string is empty. For example as stem node of a UnixFS (multi-node) file.

---

The documentation for this class was generated from the following files:

• include/ipfs_client/ipld/dag_node.h
• src/ipfs_client/ipld/dag_node.cc