Struct internet2::presentation::sphinx::Hop

pub struct Hop<Payload: SphinxPayload> {
    pub node_id: NodeId,
    pub payload: Payload,
}

Sphinx hop information

Fields

node_id: NodeId

Public key of the hop node

payload: Payload

Payload data specific for that node

Implementations

impl<Payload> Hop<Payload>where
    Payload: SphinxPayload,

pub fn with(node_id: NodeId, payload: Payload) -> Hop<Payload>

Constructs sphinx hop from a remote node public key and a payload data

pub fn payload_size(&self) -> usize

Returns size of the serialized payload plus 32 bytes for HMAC

Trait Implementations

impl<Payload: Clone + SphinxPayload> Clone for Hop<Payload>

fn clone(&self) -> Hop<Payload>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Payload: Debug + SphinxPayload> Debug for Hop<Payload>

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

Formats the value using the given formatter.

impl<Payload: Hash + SphinxPayload> Hash for Hop<Payload>

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

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<Payload: SphinxPayload> LightningDecode for Hop<Payload>

fn lightning_decode<D: Read>(d: D) -> Result<Self, Error>

Decode with the given std::io::Read instance; must either construct an instance or return implementation-specific error type.

fn lightning_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using LightningDecode::lightning_decode function.

impl<Payload: SphinxPayload> LightningEncode for Hop<Payload>

fn lightning_encode<E: Write>(&self, e: E) -> Result<usize, Error>

Encode with the given std::io::Write instance; must return result with either amount of bytes encoded – or implementation-specific error type.

fn lightning_serialize(&self) -> Result<Vec<u8, Global>, Error>

Serializes data as a byte array using LightningEncode::lightning_encode function.

impl<Payload: PartialEq + SphinxPayload> PartialEq<Hop<Payload>> for Hop<Payload>

fn eq(&self, other: &Hop<Payload>) -> 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<Payload: SphinxPayload> StrictDecode for Hop<Payload>

fn strict_decode<D: Read>(d: D) -> Result<Self, Error>

Decode with the given std::io::Read instance; must either construct an instance or return implementation-specific error type.

fn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using StrictDecode::strict_decode. If there are some data remains in the buffer once deserialization is completed, fails with Error::DataNotEntirelyConsumed. Use io::Cursor over the buffer and StrictDecode::strict_decode to avoid such failures.

fn strict_file_load(path: impl AsRef<Path>) -> Result<Self, Error>

Reads data from file at path and reconstructs object from it. Fails with Error::DataNotEntirelyConsumed if file contains remaining data after the object reconstruction.

impl<Payload: SphinxPayload> StrictEncode for Hop<Payload>

fn strict_encode<E: Write>(&self, e: E) -> Result<usize, Error>

Encode with the given std::io::Write instance; must return result with either amount of bytes encoded – or implementation-specific error type.

fn strict_serialize(&self) -> Result<Vec<u8, Global>, Error>

Serializes data as a byte array using StrictEncode::strict_encode function

fn strict_file_save(&self, path: impl AsRef<Path>) -> Result<usize, Error>

Saves data to a file at a given path. If the file does not exists, attempts to create the file. If the file already exists, it gets truncated.

impl<Payload: Eq + SphinxPayload> Eq for Hop<Payload>

impl<Payload: SphinxPayload> StructuralEq for Hop<Payload>

impl<Payload: SphinxPayload> StructuralPartialEq for Hop<Payload>