Struct TicketSelector 

pub struct TicketSelector {
    pub channel_identifier: (ChannelId, u32),
    pub index: TicketIndexSelector,
    pub win_prob: (Bound<WinningProbability>, Bound<WinningProbability>),
    pub amount: (Bound<HoprBalance>, Bound<HoprBalance>),
    pub state: Option<AcknowledgedTicketStatus>,
}

Allows selecting tickets via HoprDbTicketOperations.

The TicketSelector always allows selecting only tickets in a single channel. To select tickets across multiple channels, multiple TicketSelectors must be used.

Fields

channel_identifier: (ChannelId, u32)

Channel ID and Epoch pair.

index: TicketIndexSelector

If given, will select ticket(s) with the given indices in the given channel and epoch.

See TicketIndexSelector for possible options.

win_prob: (Bound<WinningProbability>, Bound<WinningProbability>)

If given, the tickets are further restricted to the ones with a winning probability in this range.

amount: (Bound<HoprBalance>, Bound<HoprBalance>)

If given, the tickets are further restricted to the ones with an amount in this range.

state: Option<AcknowledgedTicketStatus>

Further restriction to tickets with the given state.

Implementations

impl TicketSelector

pub fn new(channel_id: ChannelId, epoch: u32) -> Self

Create a new ticket selector given the channel_id and epoch.

pub fn is_unique(&self) -> bool

If false is returned, the selector can fetch more than a single ticket.

pub fn with_index(self, index: u64) -> Self

Returns this instance with a ticket index set.

This method can be called multiple times to select multiple tickets. If TicketSelector::with_index_range was previously called, it will be replaced.

pub fn with_index_range<T: RangeBounds<u64>>(self, index_bound: T) -> Self

Returns this instance with a ticket index upper bound set. If TicketSelector::with_index was previously called, it will be replaced.

pub fn with_state(self, state: AcknowledgedTicketStatus) -> Self

Returns this instance with a ticket state set.

pub fn with_no_state(self) -> Self

Returns this instance without a ticket state set.

pub fn with_winning_probability<T: RangeBounds<WinningProbability>>( self, range: T, ) -> Self

Returns this instance with a winning probability range bounds set.

pub fn with_amount<T: RangeBounds<HoprBalance>>(self, range: T) -> Self

Returns this instance with the ticket amount range bounds set.

Trait Implementations

impl Clone for TicketSelector

fn clone(&self) -> TicketSelector

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TicketSelector

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

Formats the value using the given formatter.

impl Display for TicketSelector

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

Formats the value using the given formatter.

impl From<&AcknowledgedTicket> for TicketSelector

fn from(value: &AcknowledgedTicket) -> Self

Converts to this type from the input type.

impl From<&ChannelEntry> for TicketSelector

fn from(value: &ChannelEntry) -> Self

Converts to this type from the input type.

impl From<&RedeemableTicket> for TicketSelector

fn from(value: &RedeemableTicket) -> Self

Converts to this type from the input type.

impl From<&VerifiedTicket> for TicketSelector

fn from(value: &VerifiedTicket) -> Self

Converts to this type from the input type.

impl From<ChannelEntry> for TicketSelector

fn from(value: ChannelEntry) -> Self

Converts to this type from the input type.

impl PartialEq for TicketSelector

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.