Struct rings_core::dht::vnode::VirtualNode

pub struct VirtualNode {
    pub did: Did,
    pub data: Vec<Encoded>,
    pub kind: VNodeType,
}

A VirtualNode is a piece of data with VNodeType and Did. You can save it to PeerRing by ChordStorage protocol.

The Did of a Virtual Node is in the following format:

• If type value is VNodeType::Data, it’s sha1 of data topic.
• If type value is VNodeType::Subring, it’s sha1 of Subring name.
• If type value is VNodeType::RelayMessage, it’s the destination Did of message plus 1 (to ensure that the message is sent to the successor of destination), thus while destination node going online, it will sync message from its successor.

Fields

did: Did

The did of VirtualNode make it unique, and can be stored and retrieved on DHT.

data: Vec<Encoded>

The data entity of VirtualNode, encoded by Encoder.

kind: VNodeType

The type indicates how the data is encoded and how the Did is generated.

Implementations

impl VirtualNode

pub fn gen_did(topic: &str) -> Result<Did>

Generate did from topic.

impl VirtualNode

pub fn affine(&self, scalar: u16) -> Vec<VirtualNode>

Affine Transport vnode to a list of affined did

pub fn clone_with_did(&self, did: Did) -> Self

Clone and setup with new DID

pub fn operate(&self, op: VNodeOperation) -> Result<Self>

The entry point of VNodeOperation. Will dispatch to different operation handlers according to the variant.

pub fn overwrite(&self, other: Self) -> Result<Self>

Overwrite current data with new data. The handler of VNodeOperation::Overwrite.

pub fn extend(&self, other: Self) -> Result<Self>

This method is used to extend data to a Data type VirtualNode. The handler of VNodeOperation::Extend.

pub fn touch(&self, other: Self) -> Result<Self>

This method is used to extend data to a Data type VirtualNode uniquely. If any element is already existed, move it to the end of the data vector. The handler of VNodeOperation::Touch.

pub fn join_subring(&self, did: Did) -> Result<Self>

This method is used to join a subring. The handler of VNodeOperation::JoinSubring.

Trait Implementations

impl Clone for VirtualNode

fn clone(&self) -> VirtualNode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VirtualNode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VirtualNode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for VirtualNode

fn eq(&self, other: &VirtualNode) -> 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 Serialize for VirtualNode

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<(String, Encoded)> for VirtualNode

type Error = Error

The type returned in the event of a conversion error.

fn try_from((topic, e): (String, Encoded)) -> Result<Self>

Performs the conversion.

impl TryFrom<(String, String)> for VirtualNode

type Error = Error

The type returned in the event of a conversion error.

fn try_from((topic, s): (String, String)) -> Result<Self>

Performs the conversion.

impl TryFrom<MessagePayload> for VirtualNode

type Error = Error

The type returned in the event of a conversion error.

fn try_from(msg: MessagePayload) -> Result<Self>

Performs the conversion.

impl TryFrom<String> for VirtualNode

type Error = Error

The type returned in the event of a conversion error.

fn try_from(topic: String) -> Result<Self>

Performs the conversion.

impl TryFrom<Subring> for VirtualNode

type Error = Error

The type returned in the event of a conversion error.

fn try_from(ring: Subring) -> Result<Self>

Performs the conversion.

impl TryFrom<VirtualNode> for Subring

type Error = Error

The type returned in the event of a conversion error.

fn try_from(vnode: VirtualNode) -> Result<Self>

Performs the conversion.

impl Eq for VirtualNode

impl StructuralPartialEq for VirtualNode