Struct hdk::hash_path::path::Component

source · [−]

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

Expand description

Each path component is arbitrary bytes to be hashed together in a predictable way when the path is hashed to create something that can be linked and discovered by all DHT participants.

Implementations

impl Component

pub fn new(v: Vec<u8>) -> Self

Trait Implementations

impl AsRef<[u8 ]> for Component

Access bytes.

fn as_ref(&self) -> &[u8 ]ⓘNotable traits for &'_ mut [u8 ]`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]`

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Component

fn clone(&self) -> Component

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 Component

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

Formats the value using the given formatter. Read more

impl Default for Component

fn default() -> Component

Returns the “default value” for a type. Read more

impl<'de> Deserialize<'de> for Component

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<&'_ String> for Component

Alias From<&str>

fn from(s: &String) -> Self

Converts to this type from the input type.

impl From<&'_ str> for Component

Build a component from a String.

For many simple use cases we can construct a path out of a string similar to a URI. We represent this using the utf32 bytes rather than the utf8 bytes for the chars in the string which gives us a fixed width encoding for strings, which gives us a clean/easy way to support sharding based on strings by iterating over u32s rather than deciding what to do with variable width u8 or u16 characters.

IMPORTANT: if you are not using sharding and make heavy use of Path then consider building your Component directly from my_string.as_bytes() to achieve much more compact utf8 representations of each Component.

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Component> for Vec<u8>

Unwrap bytes.

fn from(component: Component) -> Self

Converts to this type from the input type.

impl From<String> for Component

Alias From<&str>

fn from(s: String) -> Self

Converts to this type from the input type.

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

Wrap bytes.

fn from(v: Vec<u8>) -> Self

Converts to this type from the input type.

impl PartialEq<Component> for Component

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

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

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

This method tests for !=.

impl Serialize for Component

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<&'_ Component> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&'_ Component> for String

Restoring a String from a Component requires Vec<u8> to u32 to utf8 handling.

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(component: &Component) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Component> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<SerializedBytes> for Component

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for Component

Auto Trait Implementations

impl RefUnwindSafe for Component

impl Send for Component

impl Sync for Component

impl Unpin for Component

impl UnwindSafe for Component

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> 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<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> 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)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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>,