ChainEvent

Enum ChainEvent 

Source
pub enum ChainEvent {
    Announcement(AccountEntry),
    ChannelOpened(ChannelEntry),
    ChannelClosureInitiated(ChannelEntry),
    ChannelClosed(ChannelEntry),
    ChannelBalanceIncreased(ChannelEntry, HoprBalance),
    ChannelBalanceDecreased(ChannelEntry, HoprBalance),
    TicketRedeemed(ChannelEntry, Option<Box<VerifiedTicket>>),
    WinningProbabilityIncreased(WinningProbability),
    WinningProbabilityDecreased(WinningProbability),
    TicketPriceChanged(HoprBalance),
}
Expand description

Enumeration of HOPR chain events.

Variants§

§

Announcement(AccountEntry)

Peer on-chain announcement event.

The AccountEntry is guaranteed to be announced.

§

ChannelOpened(ChannelEntry)

A new channel has been opened

The ChannelEntry is guaranteed to be opened.

§

ChannelClosureInitiated(ChannelEntry)

Channel closure has been initiated.

The ChannelEntry is guaranteed to be pending to close.

§

ChannelClosed(ChannelEntry)

Channel closure has been finalized.

The ChannelEntry is guaranteed to be closed.

§

ChannelBalanceIncreased(ChannelEntry, HoprBalance)

Channel balance has increased by an amount.

The HoprBalance is never 0 and represents the difference from the current new balance on the ChannelEntry.

§

ChannelBalanceDecreased(ChannelEntry, HoprBalance)

Channel balance has decreased by an amount.

The HoprBalance is never 0 and represents the difference from the current new balance on the ChannelEntry.

§

TicketRedeemed(ChannelEntry, Option<Box<VerifiedTicket>>)

Ticket has been redeemed on a channel.

If the channel is a node’s own, it also contains the ticket that has been redeemed.

§

WinningProbabilityIncreased(WinningProbability)

The minimum winning probability has been increased.

§

WinningProbabilityDecreased(WinningProbability)

The minimum winning probability has been decreased.

§

TicketPriceChanged(HoprBalance)

A new ticket price has been set.

Implementations§

Source§

impl ChainEvent

Source

pub fn try_as_announcement(self) -> Option<AccountEntry>

Source

pub const fn try_as_announcement_ref(&self) -> Option<&AccountEntry>

Source

pub fn try_as_announcement_mut(&mut self) -> Option<&mut AccountEntry>

Source

pub fn try_as_channel_opened(self) -> Option<ChannelEntry>

Source

pub const fn try_as_channel_opened_ref(&self) -> Option<&ChannelEntry>

Source

pub fn try_as_channel_opened_mut(&mut self) -> Option<&mut ChannelEntry>

Source

pub fn try_as_channel_closure_initiated(self) -> Option<ChannelEntry>

Source

pub const fn try_as_channel_closure_initiated_ref( &self, ) -> Option<&ChannelEntry>

Source

pub fn try_as_channel_closure_initiated_mut( &mut self, ) -> Option<&mut ChannelEntry>

Source

pub fn try_as_channel_closed(self) -> Option<ChannelEntry>

Source

pub const fn try_as_channel_closed_ref(&self) -> Option<&ChannelEntry>

Source

pub fn try_as_channel_closed_mut(&mut self) -> Option<&mut ChannelEntry>

Source

pub fn try_as_channel_balance_increased( self, ) -> Option<(ChannelEntry, HoprBalance)>

Source

pub const fn try_as_channel_balance_increased_ref( &self, ) -> Option<(&ChannelEntry, &HoprBalance)>

Source

pub fn try_as_channel_balance_increased_mut( &mut self, ) -> Option<(&mut ChannelEntry, &mut HoprBalance)>

Source

pub fn try_as_channel_balance_decreased( self, ) -> Option<(ChannelEntry, HoprBalance)>

Source

pub const fn try_as_channel_balance_decreased_ref( &self, ) -> Option<(&ChannelEntry, &HoprBalance)>

Source

pub fn try_as_channel_balance_decreased_mut( &mut self, ) -> Option<(&mut ChannelEntry, &mut HoprBalance)>

Source

pub fn try_as_ticket_redeemed( self, ) -> Option<(ChannelEntry, Option<Box<VerifiedTicket>>)>

Source

pub const fn try_as_ticket_redeemed_ref( &self, ) -> Option<(&ChannelEntry, &Option<Box<VerifiedTicket>>)>

Source

pub fn try_as_ticket_redeemed_mut( &mut self, ) -> Option<(&mut ChannelEntry, &mut Option<Box<VerifiedTicket>>)>

Source

pub fn try_as_winning_probability_increased(self) -> Option<WinningProbability>

Source

pub const fn try_as_winning_probability_increased_ref( &self, ) -> Option<&WinningProbability>

Source

pub fn try_as_winning_probability_increased_mut( &mut self, ) -> Option<&mut WinningProbability>

Source

pub fn try_as_winning_probability_decreased(self) -> Option<WinningProbability>

Source

pub const fn try_as_winning_probability_decreased_ref( &self, ) -> Option<&WinningProbability>

Source

pub fn try_as_winning_probability_decreased_mut( &mut self, ) -> Option<&mut WinningProbability>

Source

pub fn try_as_ticket_price_changed(self) -> Option<HoprBalance>

Source

pub const fn try_as_ticket_price_changed_ref(&self) -> Option<&HoprBalance>

Source

pub fn try_as_ticket_price_changed_mut(&mut self) -> Option<&mut HoprBalance>

Source§

impl ChainEvent

Source

pub const fn is_announcement(&self) -> bool

Returns true if the enum is ChainEvent::Announcement otherwise false

Source

pub const fn is_channel_opened(&self) -> bool

Returns true if the enum is ChainEvent::ChannelOpened otherwise false

Source

pub const fn is_channel_closure_initiated(&self) -> bool

Returns true if the enum is ChainEvent::ChannelClosureInitiated otherwise false

Source

pub const fn is_channel_closed(&self) -> bool

Returns true if the enum is ChainEvent::ChannelClosed otherwise false

Source

pub const fn is_channel_balance_increased(&self) -> bool

Returns true if the enum is ChainEvent::ChannelBalanceIncreased otherwise false

Source

pub const fn is_channel_balance_decreased(&self) -> bool

Returns true if the enum is ChainEvent::ChannelBalanceDecreased otherwise false

Source

pub const fn is_ticket_redeemed(&self) -> bool

Returns true if the enum is ChainEvent::TicketRedeemed otherwise false

Source

pub const fn is_winning_probability_increased(&self) -> bool

Returns true if the enum is ChainEvent::WinningProbabilityIncreased otherwise false

Source

pub const fn is_winning_probability_decreased(&self) -> bool

Returns true if the enum is ChainEvent::WinningProbabilityDecreased otherwise false

Source

pub const fn is_ticket_price_changed(&self) -> bool

Returns true if the enum is ChainEvent::TicketPriceChanged otherwise false

Trait Implementations§

Source§

impl Clone for ChainEvent

Source§

fn clone(&self) -> ChainEvent

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ChainEvent

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for ChainEvent

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'_enum> From<&'_enum ChainEvent> for ChainEventDiscriminants

Source§

fn from(val: &'_enum ChainEvent) -> ChainEventDiscriminants

Converts to this type from the input type.
Source§

impl From<ChainEvent> for ChainEventDiscriminants

Source§

fn from(val: ChainEvent) -> ChainEventDiscriminants

Converts to this type from the input type.
Source§

impl IntoDiscriminant for ChainEvent

Source§

type Discriminant = ChainEventDiscriminants

Enum listing the same variants as this enum but without any data fields
Source§

fn discriminant(&self) -> Self::Discriminant

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
§

impl<T> ToStringFallible for T
where T: Display,

§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more