Struct rust_ipfs::path::IpfsPath

pub struct IpfsPath { /* private fields */ }

Abstraction over Ipfs paths, which are used to target sub-trees or sub-documents on top of content addressable ([Cid]) trees. The most common use case is to specify a file under an unixfs tree from underneath a [Cid] forest.

In addition to being based on content addressing, IpfsPaths provide adaptation from other Ipfs (related) functionality which can be resolved to a [Cid] such as IPNS. IpfsPaths have similar structure to and can start with a “protocol” as Multiaddr, except the protocols are different, and at the moment there can be at most one protocol.

This implementation supports:

• synonymous /ipfs and /ipld prefixes to point to a [Cid]
• /ipns to point to either:
  • PeerId to signify an IPNS DHT record
  • domain name to signify an DNSLINK reachable record

See crate::Ipfs::resolve_ipns for the current IPNS resolving capabilities.

IpfsPath is usually created through the FromStr or From conversions.

Implementations

impl IpfsPath

pub fn new(root: PathRoot) -> Self

Creates a new IpfsPath from a PathRoot.

pub fn root(&self) -> &PathRoot

Returns the PathRoot “protocol” configured for the IpfsPath.

pub fn sub_path(&self, segments: &str) -> Result<Self, Error>

Returns a new IpfsPath with the given path segments appended, or an error, if a segment is invalid.

pub fn iter(&self) -> impl Iterator<Item = &str>

Returns an iterator over the path segments following the root.

Trait Implementations

impl Clone for IpfsPath

fn clone(&self) -> IpfsPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IpfsPath

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

Formats the value using the given formatter.

impl Display for IpfsPath

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

Formats the value using the given formatter.

impl<T: Into<PathRoot>> From<T> for IpfsPath

fn from(root: T) -> Self

Converts to this type from the input type.

impl FromStr for IpfsPath

type Err = Error

The associated error which can be returned from parsing.

fn from_str(string: &str) -> Result<Self, Error>

Parses a string s to return a value of this type.

impl Hash for IpfsPath

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<IpfsPath> for IpfsPath

fn eq(&self, other: &IpfsPath) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&str> for IpfsPath

type Error = Error

The type returned in the event of a conversion error.

fn try_from(string: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for IpfsPath

impl StructuralEq for IpfsPath

impl StructuralPartialEq for IpfsPath