Struct hdk::hash_path::path::TypedPath

pub struct TypedPath {
    pub link_type: ScopedLinkType,
    pub path: Path,
}

A LinkType applied to a Path.

All links committed from this path will have this link type.

Get a typed path from a path and a link type:

let typed_path = path.typed(LinkTypes::MyLink)?;

Fields

link_type: ScopedLinkType

The LinkType within the scope of the zome where it’s defined.

path: Path

The Path that is using this LinkType.

Implementations

impl TypedPath

pub fn new(link_type: impl Into<ScopedLinkType>, path: Path) -> Self

Create a new TypedPath by attaching a ZomeId and LinkType to a Path.

pub fn exists(&self) -> ExternResult<bool>

Does an entry exist at the hash we expect?

pub fn ensure(&self) -> ExternResult<()>

Recursively touch this and every parent that doesn’t exist yet.

pub fn parent(&self) -> Option<Self>

The parent of the current path is simply the path truncated one level.

pub fn children(&self) -> ExternResult<Vec<Link>>

Touch and list all the links from this path to paths below it. Only returns links between paths, not to other entries that might have their own links.

pub fn children_paths(&self) -> ExternResult<Vec<Self>>

Touch and list all the links from this path to paths below it. Same as Path::children but returns Vec<Path> rather than Vec<Link>. This is more than just a convenience. In general it’s not possible to construct a full Path from a child Link alone as only a single Component is encoded into the link tag. To build a full child path the parent path + child link must be combined, which this function does to produce each child, by using &self as that parent.

pub fn children_details(&self) -> ExternResult<LinkDetails>

Methods from Deref<Target = Path>

pub fn path_entry_hash(&self) -> ExternResult<EntryHash>

What is the hash for the current Path ?

pub fn leaf(&self) -> Option<&Component>

Accessor for the last Component of this Path. This can be thought of as the leaf of the implied tree structure of which this Path is one branch of.

pub fn make_tag(&self) -> ExternResult<LinkTag>

Make the LinkTag for this Path.

pub fn is_root(&self) -> bool

Check if this Path is the root.

Trait Implementations

impl Clone for TypedPath

fn clone(&self) -> TypedPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TypedPath

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

Formats the value using the given formatter.

impl Deref for TypedPath

type Target = Path

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for TypedPath

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<TypedPath> for Path

fn from(p: TypedPath) -> Self

Converts to this type from the input type.

impl PartialEq<TypedPath> for TypedPath

fn eq(&self, other: &TypedPath) -> 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 Serialize for TypedPath

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&TypedPath> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(t: &TypedPath) -> Result<SerializedBytes, SerializedBytesError>

Performs the conversion.

impl TryFrom<SerializedBytes> for TypedPath

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(sb: SerializedBytes) -> Result<TypedPath, SerializedBytesError>

Performs the conversion.

impl TryFrom<TypedPath> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(t: TypedPath) -> Result<SerializedBytes, SerializedBytesError>

Performs the conversion.

impl StructuralPartialEq for TypedPath