Struct NodeIdRef

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

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

Implementations

impl<'a, const N: usize> NodeIdRef<'a, N>

pub const MAX_SIZE: usize = N

The maximum length of an id is N bytes.

pub fn new(src: &'a str) -> Result<NodeIdRef<'a, N>, ParseNodeIdError>

Creates a new Id from the source.

pub const fn as_str(&self) -> &'a str

converts the Id into a &str.

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

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

pub fn to_owned(&self) -> NodeId<N>

Converts to owned NodeId.

Trait Implementations

impl<const N: usize> AsRef<str> for NodeIdRef<'_, 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 NodeIdRef<'_, N>

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<const N: usize> CheapClone for NodeIdRef<'_, N>

fn cheap_clone(&self) -> Self

Returns a copy of the value.

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

fn clone(&self) -> NodeIdRef<'a, N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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 NodeIdRef<'_, N>

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

Formats the value using the given formatter.

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

fn deserialize<D>( deserializer: D, ) -> Result<NodeIdRef<'de, N>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const N: usize> Display for NodeIdRef<'_, N>

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

Formats the value using the given formatter.

impl<'a, const N: usize> Hash for NodeIdRef<'a, 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<'a, const N: usize> Ord for NodeIdRef<'a, N>

fn cmp(&self, other: &NodeIdRef<'a, 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<'a, const N: usize> PartialEq for NodeIdRef<'a, N>

fn eq(&self, other: &NodeIdRef<'a, N>) -> bool

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

const 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<'a, const N: usize> PartialOrd for NodeIdRef<'a, N>

fn partial_cmp(&self, other: &NodeIdRef<'a, 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 NodeIdRef<'_, 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<'a, const N: usize> TryFrom<&'a [u8]> for NodeIdRef<'a, N>

type Error = ParseNodeIdError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a, const N: usize> TryFrom<&'a str> for NodeIdRef<'a, N>

type Error = ParseNodeIdError

The type returned in the event of a conversion error.

fn try_from( value: &'a str, ) -> Result<NodeIdRef<'a, N>, <NodeIdRef<'a, N> as TryFrom<&'a str>>::Error>

Performs the conversion.

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

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

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