Struct hdk::hash_path::anchor::Anchor

pub struct Anchor {
    pub anchor_type: String,
    pub anchor_text: Option<String>,
}

An anchor can only be 1 or 2 levels deep as “type” and “text”.

The second level is optional and the Strings use the standard TryInto for path Component internally.

Anchors are required to be included in an application’s [ entry_defs ] callback and so implement all the standard methods. Technically the Anchor entry definition is the Path definition.

e.g. entry_defs![Anchor::entry_def()]

The methods implemented on anchor follow the patterns that predate the Path module but Path::from(&anchor) is always possible to use the newer APIs.

Fields

anchor_type: String

anchor_text: Option<String>

Trait Implementations

impl Clone for Anchor

fn clone(&self) -> Anchor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Anchor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Anchor

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

Deserialize this value from the given Serde deserializer.

impl From<&Anchor> for Path

Anchors are just a special case of path, so we can move from anchor to path losslessly. We simply format the anchor structure into a string that works with the path string handling.

fn from(anchor: &Anchor) -> Self

Converts to this type from the input type.

impl PartialEq<Anchor> for Anchor

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

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

Serialize this value into the given Serde serializer.

impl TryFrom<&Anchor> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Path> for Anchor

Paths are more general than anchors so a path could be represented that is not a valid anchor. The obvious example would be a path of binary data that is not valid utf-8 strings or a path that is more than 2 levels deep.

type Error = WasmError

The type returned in the event of a conversion error.

fn try_from(path: &Path) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Anchor> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<SerializedBytes> for Anchor

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for Anchor