Struct Component 

pub struct Component(/* private fields */);

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

Trait Implementations

impl AsRef<[u8]> for Component

Access bytes.

fn as_ref(&self) -> &[u8]

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

impl Clone for Component

fn clone(&self) -> Component

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Component

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

Formats the value using the given formatter.

impl Default for Component

fn default() -> Component

Returns the “default value” for a type.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&String> for Component

Alias From<&str>

fn from(s: &String) -> Component

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

Converts to this type from the input type.

impl From<Component> for Vec<u8>

Unwrap bytes.

fn from(component: Component) -> Vec<u8>

Converts to this type from the input type.

impl From<String> for Component

Alias From<&str>

fn from(s: String) -> Component

Converts to this type from the input type.

impl From<Vec<u8>> for Component

Wrap bytes.

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

Converts to this type from the input type.

impl PartialEq for Component

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Component

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

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<String, <String as TryFrom<&Component>>::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