Enum GossipExt

pub enum GossipExt {
    MainRouter = 0,
    DirectRouter = 1,
    GossipRouter = 2,
}

Variants

MainRouter = 0

DirectRouter = 1

GossipRouter = 2

Trait Implementations

impl Clone for GossipExt

fn clone(&self) -> GossipExt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GossipExt

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

Formats the value using the given formatter.

impl Default for GossipExt

fn default() -> Self

Returns the “default value” for a type.

impl Display for GossipExt

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

Formats the value using the given formatter.

impl Extension<GossipExt> for DirectRouter

fn identity(&self) -> GossipExt

fn update_from_peer(&mut self, message: &Messages) -> Result<(), Error>

Updates extension state from the data taken from the message received from the remote peer

fn update_from_local(&mut self, message: &UpdateMsg) -> Result<(), Error>

Updates extension state from some local data

fn load_state(&mut self, state: &RouterState)

fn store_state(&self, state: &mut RouterState)

fn state_change( &mut self, request: &<N as Nomenclature>::UpdateRequest, message: &mut <N as Nomenclature>::PeerMessage, ) -> Result<(), <N as Nomenclature>::Error>

Perform a sate change and produce a message which should be communicated to peers notifying them about the state change

impl Extension<GossipExt> for GossipRouter

fn identity(&self) -> GossipExt

fn update_from_local(&mut self, _message: &UpdateMsg) -> Result<(), Error>

Updates extension state from some local data

fn update_from_peer(&mut self, message: &Messages) -> Result<(), Error>

Updates extension state from the data taken from the message received from the remote peer

fn load_state(&mut self, state: &RouterState)

fn store_state(&self, state: &mut RouterState)

fn state_change( &mut self, request: &<N as Nomenclature>::UpdateRequest, message: &mut <N as Nomenclature>::PeerMessage, ) -> Result<(), <N as Nomenclature>::Error>

Perform a sate change and produce a message which should be communicated to peers notifying them about the state change

impl From<GossipExt> for u16

fn from(id: GossipExt) -> Self

Converts to this type from the input type.

impl Hash for GossipExt

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 Nomenclature for GossipExt

type State = RouterState

type Error = Error

type PeerMessage = Messages

type UpdateMessage = UpdateMsg

type UpdateRequest = ()

impl Nomenclature for GossipExt

type HopPayload = PaymentOnion

fn default_extensions() -> Vec<Box<dyn RouterExtension<Self>>>

fn update_from_peer( _router: &mut Router<Self>, _message: &Messages, ) -> Result<(), Error>

Updates router extension structure from peer message. Processed before each of the registered extensions gets Extension::update_from_peer

impl Ord for GossipExt

fn cmp(&self, other: &GossipExt) -> 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 PartialEq for GossipExt

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

fn partial_cmp(&self, other: &GossipExt) -> 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 RouterExtension<GossipExt> for DirectRouter

fn new() -> Box<dyn RouterExtension<GossipExt>>

where Self: Sized,

Constructs boxed extension objects which can be inserted into router extension pipeline

fn build_route( &mut self, payment: PaymentRequest, route: &mut Vec<Hop<PaymentOnion>>, )

impl RouterExtension<GossipExt> for GossipRouter

fn new() -> Box<dyn RouterExtension<GossipExt>>

where Self: Sized,

Constructs boxed extension objects which can be inserted into router extension pipeline

fn build_route( &mut self, _payment: PaymentRequest, _route: &mut Vec<Hop<PaymentOnion>>, )

impl StrictDecode for GossipExt

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 StrictEncode for GossipExt

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>, 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 TryFrom<u16> for GossipExt

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: u16) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for GossipExt

impl Eq for GossipExt

impl StructuralPartialEq for GossipExt