Struct hdk::hash_path::path::TypedPath

source · [−]

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

Expand description

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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for TypedPath

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

Formats the value using the given formatter. Read more

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. Read more

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 ==. Read more

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

This method tests for !=.

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. Read more

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

Auto Trait Implementations

impl RefUnwindSafe for TypedPath

impl Send for TypedPath

impl Sync for TypedPath

impl Unpin for TypedPath

impl UnwindSafe for TypedPath

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> ArchivePointee for T

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.

fn pointer_metadata(
&<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<F, W, T, D> Deserialize<With<T, W>, D> for F where
    W: DeserializeWith<F, T, D>,
    D: Fallible + ?Sized,
    F: ?Sized,

fn deserialize(
&self,
deserializer: &mut D
) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointee for T

type Metadata = ()

The type for metadata in pointers and references to Self.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;` where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,