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 field.
• 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 concat(a: &Self, b: &Self) -> Result<Self>

concat data of a virtual Node We do not needs to check the type of VNode because two VNode with same did but has different Type is incapable

Examples found in repository

src/dht/chord.rs (line 380)

    async fn store(&self, vnode: VirtualNode) -> Result<PeerRingAction> {
        let vid = vnode.did;
        match self.find_successor(vid) {
            // `vnode` should be stored in current node.
            Ok(PeerRingAction::Some(_)) => match self.storage.get(&vid).await {
                Ok(v) => {
                    let _ = self
                        .storage
                        .put(&vid, &VirtualNode::concat(&v, &vnode)?)
                        .await?;
                    Ok(PeerRingAction::None)
                }
                Err(_) => {
                    let _ = self.storage.put(&vid, &vnode).await?;
                    Ok(PeerRingAction::None)
                }
            },
            // `vnode` should be stored in other nodes.
            // Return an action to describe how to store it.
            Ok(PeerRingAction::RemoteAction(n, RemoteAction::FindSuccessor(_))) => Ok(
                PeerRingAction::RemoteAction(n, RemoteAction::FindAndStore(vnode)),
            ),
            Ok(a) => Err(Error::PeerRingUnexpectedAction(a)),
            Err(e) => Err(e),
        }
    }

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<VirtualNode> 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<Encoded> for VirtualNode

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> TryFrom<MessagePayload<T>> for VirtualNodewhere
    T: Serialize + DeserializeOwned,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(msg: MessagePayload<T>) -> 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(s: 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 StructuralEq for VirtualNode

impl StructuralPartialEq for VirtualNode