Enum TimeoutHeight

pub enum TimeoutHeight {
    Never,
    At(Height),
}

Indicates a consensus height on the destination chain after which the packet will no longer be processed, and will instead count as having timed-out.

TimeoutHeight is treated differently from other heights because

RawHeight.timeout_height == {revision_number: 0, revision_height = 0}

is legal and meaningful, even though the Tendermint spec rejects this height as invalid. Thus, it must be parsed specially, where this special case means “no timeout”.

Variants

Never

At(Height)

Implementations

impl TimeoutHeight

pub fn no_timeout() -> TimeoutHeight

pub fn commitment_revision_number(&self) -> u64

Revision number to be used in packet commitment computation

pub fn commitment_revision_height(&self) -> u64

Revision height to be used in packet commitment computation

pub fn has_expired(&self, height: Height) -> bool

Check if a height is stricly past the timeout height, and thus is deemed expired.

pub fn to_event_attribute_value(self) -> String

Returns a string formatted for an ABCI event attribute value.

Trait Implementations

impl Clone for TimeoutHeight

fn clone(&self) -> TimeoutHeight

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimeoutHeight

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

Formats the value using the given formatter.

impl Default for TimeoutHeight

fn default() -> TimeoutHeight

Returns the “default value” for a type.

impl Display for TimeoutHeight

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

Formats the value using the given formatter.

impl From<Height> for TimeoutHeight

fn from(height: Height) -> TimeoutHeight

Converts to this type from the input type.

impl FromStr for TimeoutHeight

type Err = <Height as FromStr>::Err

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<TimeoutHeight, <TimeoutHeight as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for TimeoutHeight

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

where __H: Hasher,

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 PartialEq for TimeoutHeight

fn eq(&self, other: &TimeoutHeight) -> 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 TryFrom<Height> for TimeoutHeight

type Error = Error

The type returned in the event of a conversion error.

fn try_from( raw_height: Height, ) -> Result<TimeoutHeight, <TimeoutHeight as TryFrom<Height>>::Error>

Performs the conversion.

impl TryFrom<Option<Height>> for TimeoutHeight

type Error = Error

The type returned in the event of a conversion error.

fn try_from( maybe_raw_height: Option<Height>, ) -> Result<TimeoutHeight, <TimeoutHeight as TryFrom<Option<Height>>>::Error>

Performs the conversion.

impl Copy for TimeoutHeight

impl Eq for TimeoutHeight

impl StructuralPartialEq for TimeoutHeight