Enum RoundIndex

pub enum RoundIndex {
    Collateral,
    Round(usize),
}

Round index is used to represent the round index safely. Collateral represents the collateral utxo. Round(index) represents the rounds of the bridge operators, index is 0-indexed. As a single u32, collateral is represented as 0 and rounds are represented starting from 1.

Variants

Collateral

Round(usize)

Implementations

impl RoundIndex

pub fn to_index(&self) -> usize

Converts the round to a 0-indexed index.

pub fn from_index(index: usize) -> Self

Converts a 0-indexed index to a RoundIndex. Use this only when dealing with 0-indexed data. Currently these are data coming from the database and rpc.

pub fn next_round(&self) -> Self

Returns the next RoundIndex.

pub fn iter_rounds(num_rounds: usize) -> impl Iterator<Item = RoundIndex>

Creates an iterator over rounds from 0 to num_rounds (exclusive) Only iterates actual rounds, collateral is not included.

pub fn iter_rounds_range( start: usize, end: usize, ) -> impl Iterator<Item = RoundIndex>

Creates an iterator over rounds from start to end (exclusive) Only iterates actual rounds, collateral is not included.

Trait Implementations

impl Clone for RoundIndex

fn clone(&self) -> RoundIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoundIndex

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RoundIndex

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for RoundIndex

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 Ord for RoundIndex

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

fn eq(&self, other: &RoundIndex) -> 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.

impl PartialOrd for RoundIndex

fn partial_cmp(&self, other: &RoundIndex) -> 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 Serialize for RoundIndex

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for RoundIndex

impl Eq for RoundIndex

impl StructuralPartialEq for RoundIndex