Struct NodeId 

pub struct NodeId<const N: usize = nodecraft::::id::impls::id::NodeId::{constant#0}>(/* private fields */);

A unique string identifying a server for all time. The maximum length of an id is 512 bytes.

Implementations

impl<const N: usize> NodeId<N>

pub const MAX_SIZE: usize = N

The maximum length of an id is N bytes.

pub fn new<T>(src: T) -> Result<NodeId<N>, ParseNodeIdError>

where T: AsRef<str>,

Creates a new Id from the source.

pub fn as_str(&self) -> &str

converts the Id into a &str.

pub fn as_bytes(&self) -> &[u8]

Returns a byte slice. To convert the byte slice back into a string slice, use the core::str::from_utf8 function.

Trait Implementations

impl<const N: usize> AsRef<str> for NodeId<N>

fn as_ref(&self) -> &str

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

impl<const N: usize> Borrow<str> for NodeId<N>

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<const N: usize> CheapClone for NodeId<N>

fn cheap_clone(&self) -> Self

Returns a copy of the value.

impl<const N: usize> Clone for NodeId<N>

fn clone(&self) -> NodeId<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Data for NodeId<N>

type Ref<'a> = NodeIdRef<'a, N>

The reference type of the data.

fn from_ref(val: <NodeId<N> as Data>::Ref<'_>) -> Result<NodeId<N>, DecodeError>

Converts the reference type to the owned type.

fn encoded_len(&self) -> usize

Returns the encoded length of the data only considering the data itself, (e.g. no length prefix, no wire type).

fn encode(&self, buf: &mut [u8]) -> Result<usize, EncodeError>

Encodes the message to a buffer.

const WIRE_TYPE: WireType = WireType::LengthDelimited

The wire type of the data.

fn encoded_len_with_length_delimited(&self) -> usize

Returns the encoded length of the data including the length delimited.

fn encode_to_vec(&self) -> Result<Vec<u8>, EncodeError>

Encodes the message into a vec.

fn encode_to_bytes(&self) -> Result<Bytes, EncodeError>

Encodes the message into a Bytes.

fn encode_length_delimited(&self, buf: &mut [u8]) -> Result<usize, EncodeError>

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Result<Vec<u8>, EncodeError>

Encodes the message with a length-delimiter into a vec.

fn encode_length_delimited_to_bytes(&self) -> Result<Bytes, EncodeError>

Encodes the message with a length-delimiter into a Bytes.

fn decode(src: &[u8]) -> Result<(usize, Self), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: &[u8]) -> Result<(usize, Self), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from the buffer.

impl<'a, const N: usize> DataRef<'a, NodeId<N>> for NodeIdRef<'a, N>

fn decode(buf: &'a [u8]) -> Result<(usize, NodeIdRef<'a, N>), DecodeError>

Decodes the reference type from a buffer.

fn decode_length_delimited(src: &'a [u8]) -> Result<(usize, Self), DecodeError>

where Self: Sized,

Decodes a length-delimited reference instance of the message from the buffer.

impl<const N: usize> Debug for NodeId<N>

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

Formats the value using the given formatter.

impl<'de, const N: usize> Deserialize<'de> for NodeId<N>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const N: usize> Display for NodeId<N>

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

Formats the value using the given formatter.

impl<const N: usize> FromStr for NodeId<N>

type Err = ParseNodeIdError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<NodeId<N>, <NodeId<N> as FromStr>::Err>

Parses a string s to return a value of this type.

impl<const N: usize> Hash for NodeId<N>

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<const N: usize> Ord for NodeId<N>

fn cmp(&self, other: &NodeId<N>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<const N: usize> PartialEq for NodeId<N>

fn eq(&self, other: &NodeId<N>) -> 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<const N: usize> PartialOrd for NodeId<N>

fn partial_cmp(&self, other: &NodeId<N>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const N: usize> Serialize for NodeId<N>

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<const N: usize> TryFrom<&[u8]> for NodeId<N>

type Error = ParseNodeIdError

The type returned in the event of a conversion error.

fn try_from( value: &[u8], ) -> Result<NodeId<N>, <NodeId<N> as TryFrom<&[u8]>>::Error>

Performs the conversion.

impl<const N: usize> TryFrom<IpAddr> for NodeId<N>

type Error = ParseNodeIdError

The type returned in the event of a conversion error.

fn try_from( value: IpAddr, ) -> Result<NodeId<N>, <NodeId<N> as TryFrom<IpAddr>>::Error>

Performs the conversion.

impl<const N: usize> TryFrom<Ipv4Addr> for NodeId<N>

type Error = ParseNodeIdError

The type returned in the event of a conversion error.

fn try_from( value: Ipv4Addr, ) -> Result<NodeId<N>, <NodeId<N> as TryFrom<Ipv4Addr>>::Error>

Performs the conversion.

impl<const N: usize> TryFrom<Ipv6Addr> for NodeId<N>

type Error = ParseNodeIdError

The type returned in the event of a conversion error.

fn try_from( value: Ipv6Addr, ) -> Result<NodeId<N>, <NodeId<N> as TryFrom<Ipv6Addr>>::Error>

Performs the conversion.

impl<const N: usize> TryFrom<SocketAddr> for NodeId<N>

type Error = ParseNodeIdError

The type returned in the event of a conversion error.

fn try_from( value: SocketAddr, ) -> Result<NodeId<N>, <NodeId<N> as TryFrom<SocketAddr>>::Error>

Performs the conversion.

impl<const N: usize> TryFrom<SocketAddrV4> for NodeId<N>

type Error = ParseNodeIdError

The type returned in the event of a conversion error.

fn try_from( value: SocketAddrV4, ) -> Result<NodeId<N>, <NodeId<N> as TryFrom<SocketAddrV4>>::Error>

Performs the conversion.

impl<const N: usize> TryFrom<SocketAddrV6> for NodeId<N>

type Error = ParseNodeIdError

The type returned in the event of a conversion error.

fn try_from( value: SocketAddrV6, ) -> Result<NodeId<N>, <NodeId<N> as TryFrom<SocketAddrV6>>::Error>

Performs the conversion.

impl<const N: usize> TryFrom<String> for NodeId<N>

type Error = ParseNodeIdError

The type returned in the event of a conversion error.

fn try_from( s: String, ) -> Result<NodeId<N>, <NodeId<N> as TryFrom<String>>::Error>

Performs the conversion.

impl<const N: usize> TryFrom<Vec<u8>> for NodeId<N>

type Error = ParseNodeIdError

The type returned in the event of a conversion error.

fn try_from( value: Vec<u8>, ) -> Result<NodeId<N>, <NodeId<N> as TryFrom<Vec<u8>>>::Error>

Performs the conversion.

impl<const N: usize> Eq for NodeId<N>

impl<const N: usize> StructuralPartialEq for NodeId<N>