Struct ruserf_types::Node

pub struct Node<I, A> { /* private fields */ }

Node is consist of id and address, which can be used as a identifier in a distributed system.

Implementations

impl<I, A> Node<I, A>

pub const fn new(id: I, address: A) -> Node<I, A>

Create a new node with id and address.

pub const fn id(&self) -> &I

Returns the id of the node.

pub const fn address(&self) -> &A

Returns the address of the node.

pub fn set_address(&mut self, address: A) -> &mut Node<I, A>

Set the address of the node.

pub fn set_id(&mut self, id: I) -> &mut Node<I, A>

Set the id of the node.

pub fn with_address(self, address: A) -> Node<I, A>

Set the address of the node. (Builder pattern)

pub fn with_id(self, id: I) -> Node<I, A>

Set the id of the node. (Builder pattern)

pub fn into_components(self) -> (I, A)

Consumes the node and returns the id and address of the node.

pub fn map_address<U>(self, f: impl FnOnce(A) -> U) -> Node<I, U>

Maps an Node<I, A> to Node<I, U> by applying a function to the current node.

Example

use nodecraft::Node;

let node = Node::new("test", 100u64);
let node = node.map_address(|address| address.to_string());
assert_eq!(node.address(), "100");

pub fn map_id<U>(self, f: impl FnOnce(I) -> U) -> Node<U, A>

Maps an Node<I, A> to Node<U, A> by applying a function to the current node.

Example

use nodecraft::Node;

let node = Node::new(1u64, 100u64);
let node = node.map_id(|id| id.to_string());
assert_eq!(node.id(), "1");

pub fn map<U, V>(self, f: impl FnOnce(I, A) -> (U, V)) -> Node<U, V>

Maps an Node<I, A> to Node<U, V> by applying a function to the current node.

Example

use nodecraft::Node;

let node = Node::new(1u64, 100u64);

let node = node.map(|id, address| (id.to_string(), address.to_string()));

assert_eq!(node.id(), "1");
assert_eq!(node.address(), "100");

Trait Implementations

impl<I, A> CheapClone for Node<I, A>

where I: CheapClone, A: CheapClone,

fn cheap_clone(&self) -> Node<I, A>

Returns a copy of the value.

impl<I, A> Clone for Node<I, A>

where I: Clone, A: Clone,

fn clone(&self) -> Node<I, A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I, A> Debug for Node<I, A>

where I: Debug, A: Debug,

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

Formats the value using the given formatter.

impl<'de, I, A> Deserialize<'de> for Node<I, A>

where I: Deserialize<'de>, A: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<I, A> Display for Node<I, A>

where I: Display, A: Display,

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

Formats the value using the given formatter.

impl<I, A> From<(I, A)> for Node<I, A>

fn from(_: (I, A)) -> Node<I, A>

Converts to this type from the input type.

impl<I, A> Hash for Node<I, A>

where I: Hash, A: Hash,

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<I, A> Ord for Node<I, A>

where I: Ord, A: Ord,

fn cmp(&self, other: &Node<I, A>) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<I, A> PartialEq for Node<I, A>

where I: PartialEq, A: PartialEq,

fn eq(&self, other: &Node<I, A>) -> bool

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

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

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

impl<I, A> PartialOrd for Node<I, A>

where I: PartialOrd, A: PartialOrd,

fn partial_cmp(&self, other: &Node<I, A>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<I, A> Serialize for Node<I, A>

where I: Serialize, A: Serialize,

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<I, A> Transformable for Node<I, A>

where I: Transformable, A: Transformable,

type Error = NodeTransformError<I, A>

The error type returned when encoding or decoding fails.

fn encode( &self, dst: &mut [u8] ) -> Result<usize, <Node<I, A> as Transformable>::Error>

Encodes the value into the given buffer for transmission.

fn encoded_len(&self) -> usize

Returns the encoded length of the value. This is used to pre-allocate a buffer for encoding.

fn decode( src: &[u8] ) -> Result<(usize, Node<I, A>), <Node<I, A> as Transformable>::Error>

where Node<I, A>: Sized,

Decodes the value from the given buffer received over the wire.

fn encode_to_vec(&self) -> Result<Vec<u8>, Self::Error>

Encodes the value into a vec for transmission.

fn encode_to_writer<W>(&self, writer: &mut W) -> Result<usize, Error>

where W: Write,

Encodes the value into the given writer for transmission.

fn encode_to_async_writer<W>( &self, writer: &mut W ) -> impl Future<Output = Result<usize, Error>> + Send

where W: AsyncWrite + Send + Unpin,

Encodes the value into the given async writer for transmission.

fn decode_from_reader<R>(reader: &mut R) -> Result<(usize, Self), Error>

where R: Read, Self: Sized,

Decodes the value from the given reader received over the wire.

fn decode_from_async_reader<R>( reader: &mut R ) -> impl Future<Output = Result<(usize, Self), Error>> + Send

where R: AsyncRead + Send + Unpin, Self: Sized,

Decodes the value from the given async reader received over the wire.

impl<I, A> Copy for Node<I, A>

where I: Copy, A: Copy,

impl<I, A> Eq for Node<I, A>

where I: Eq, A: Eq,

impl<I, A> StructuralPartialEq for Node<I, A>