Struct hdk::hash_path::path::Path

#[repr(transparent)]
pub struct Path(_);

A Path is a vector of Component . It represents a single traversal of a tree structure down to some arbitrary point. The main intent is that we can recursively walk back up the tree, hashing, committing and linking each sub-path along the way until we reach the root. At this point it is possible to follow DHT links from the root back up the path. i.e. the ahead-of-time predictability of the hashes of a given path allows us to travel “up” the tree and the linking functionality of the holochain DHT allows us to travel “down” the tree after at least one DHT participant has followed the path “up”.

Implementations

impl Path

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

What is the hash for the current 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<Path>

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

pub fn children(&self) -> ExternResult<Links>

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

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

Trait Implementations

impl AsRef<Vec<Component, Global>> for Path

Access components vector.

fn as_ref(&self) -> &Vec<Component>

Performs the conversion.

impl Clone for Path

fn clone(&self) -> Path

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Path

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

Formats the value using the given formatter.

impl Default for Path

fn default() -> Path

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Path

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

Deserialize this value from the given Serde deserializer.

impl EntryDefRegistration for Path

fn entry_def() -> EntryDef

fn entry_def_id() -> EntryDefId

fn entry_visibility() -> EntryVisibility

fn crdt_type() -> CrdtType

fn required_validations() -> RequiredValidations

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

Performs the conversion.

impl From<&'_ Path> for EntryDef where
    Path: EntryDefRegistration, 

fn from(_: &Path) -> Self

Performs the conversion.

impl From<&'_ Path> for EntryDefId where
    Path: EntryDefRegistration, 

fn from(_: &Path) -> Self

Performs the conversion.

impl From<&'_ Path> for EntryVisibility where
    Path: EntryDefRegistration, 

fn from(_: &Path) -> Self

Performs the conversion.

impl From<&'_ Path> for CrdtType where
    Path: EntryDefRegistration, 

fn from(_: &Path) -> Self

Performs the conversion.

impl From<&'_ Path> for RequiredValidations where
    Path: EntryDefRegistration, 

fn from(_: &Path) -> Self

Performs the conversion.

impl From<&'_ String> for Path

Alias From<&str>

fn from(s: &String) -> Self

Performs the conversion.

impl From<&'_ str> for Path

Split a string path out into a vector of components. This allows us to construct pseudo-URI-path-things as strings. It is a simpler scheme than URLs and file paths. Leading and trailing slashes are ignored as are duplicate dots and the empty string leads to a path with zero length (no components).

e.g. all the following result in the same components as vec!["foo", "bar"] (as bytes)

• foo.bar
• foo.bar.
• .foo.bar
• .foo.bar.
• foo..bar

There is no normalisation of paths, e.g. to guarantee a specific root component exists, at this layer so there is a risk that there are hash collisions with other data on the DHT network if some disambiguation logic is not included in higher level abstractions.

This supports sharding strategies from a small inline DSL. Start each component with :# to get shards out of the string.

e.g.

• foo.barbaz => normal path as above [“foo”, “barbaz”]
• foo.1:3#barbazii => width 1, depth 3, [“foo”, “b”, “a”, “r”, “barbazii”]
• foo.2:3#barbazii => width 2, depth 3, [“foo”, “ba”, “rb”, “az”, “barbazii”]

Note that this all works because the components and sharding for strings maps to fixed-width utf32 bytes under the hood rather than variable width bytes.

fn from(s: &str) -> Self

Performs the conversion.

impl From<(&'_ ShardStrategy, &'_ [u8])> for Path

Builds a path for a shard strategy and some binary bytes. This is the trivial case, we just split the bytes out one by one and make a path from it.

fn from((strategy, bytes): (&ShardStrategy, &[u8])) -> Path

Performs the conversion.

impl From<(&'_ ShardStrategy, &'_ String)> for Path

[ &String ] wrapper mimicing &str for Path building.

fn from((strategy, s): (&ShardStrategy, &String)) -> Path

Performs the conversion.

impl From<(&'_ ShardStrategy, &'_ Vec<u8, Global>)> for Path

Wrapper around &Vec to work the same as &u8.

fn from((strategy, bytes): (&ShardStrategy, &Vec<u8>)) -> Path

Performs the conversion.

impl From<(&'_ ShardStrategy, &'_ str)> for Path

Create Path from String . To ensure that this works for all utf8, which can have anywhere from 1-4 bytes for a single character, we first represent each character as a utf32 so it gets padded out with 0 bytes. This means the width is 4x what it would be for raw bytes with the same strategy.

fn from((strategy, s): (&ShardStrategy, &str)) -> Path

Performs the conversion.

impl From<(&'_ ShardStrategy, String)> for Path

fn from((strategy, s): (&ShardStrategy, String)) -> Path

Performs the conversion.

impl From<(&'_ ShardStrategy, Vec<u8, Global>)> for Path

Wrapper around Vec to work the same as &u8.

fn from((strategy, bytes): (&ShardStrategy, Vec<u8>)) -> Path

Performs the conversion.

impl From<Path> for EntryDef where
    Path: EntryDefRegistration, 

fn from(_: Path) -> Self

Performs the conversion.

impl From<Path> for EntryDefId where
    Path: EntryDefRegistration, 

fn from(_: Path) -> Self

Performs the conversion.

impl From<Path> for EntryVisibility where
    Path: EntryDefRegistration, 

fn from(_: Path) -> Self

Performs the conversion.

impl From<Path> for CrdtType where
    Path: EntryDefRegistration, 

fn from(_: Path) -> Self

Performs the conversion.

impl From<Path> for RequiredValidations where
    Path: EntryDefRegistration, 

fn from(_: Path) -> Self

Performs the conversion.

impl From<Path> for Vec<Component>

Unwrap components vector.

fn from(path: Path) -> Self

Performs the conversion.

impl From<String> for Path

Alias From<&str>

fn from(s: String) -> Self

Performs the conversion.

impl From<Vec<Component, Global>> for Path

Wrap components vector.

fn from(components: Vec<Component>) -> Self

Performs the conversion.

impl PartialEq<Path> for Path

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

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

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

This method tests for !=.

impl Serialize for Path

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

Serialize this value into the given Serde serializer.

impl TryFrom<&'_ Element> for Path

type Error = WasmError

The type returned in the event of a conversion error.

fn try_from(element: &Element) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ Entry> for Path

type Error = WasmError

The type returned in the event of a conversion error.

fn try_from(entry: &Entry) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&'_ LinkTag> for Path

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(link_tag: &LinkTag) -> Result<Self, Self::Error>

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 = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&'_ Path> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&'_ Path> for Entry

type Error = WasmError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&'_ Path> for EntryWithDefId where
    Path: EntryDefRegistration, 

type Error = WasmError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&'_ Path> for LinkTag

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Element> for Path

type Error = WasmError

The type returned in the event of a conversion error.

fn try_from(element: Element) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Entry> for Path

type Error = WasmError

The type returned in the event of a conversion error.

fn try_from(entry: Entry) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<HoloHashed<Entry>> for Path

type Error = WasmError

The type returned in the event of a conversion error.

fn try_from(entry_hashed: EntryHashed) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Path> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Path> for Entry

type Error = WasmError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Path> for EntryWithDefId

type Error = WasmError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<SerializedBytes> for Path

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for Path