Enum ibc::core::ics04_channel::timeout::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() -> Self

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.

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

Formats the value using the given formatter.

impl Default for TimeoutHeight

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TimeoutHeight

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for TimeoutHeight

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

Formats the value using the given formatter.

impl From<Height> for TimeoutHeight

fn from(height: Height) -> Self

Converts to this type from the input type.

impl From<TimeoutHeight> for Option<RawHeight>

We map “no timeout height” to Some(RawHeight::zero) due to a quirk in ICS-4. See https://github.com/cosmos/ibc/issues/776.

fn from(timeout_height: TimeoutHeight) -> Self

Converts to this type from the input type.

impl From<TimeoutHeight> for TagValue

fn from(timeout_height: TimeoutHeight) -> Self

Converts to this type from the input type.

impl Hash for TimeoutHeight

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<TimeoutHeight> for TimeoutHeight

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for TimeoutHeight

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl TryFrom<Height> for TimeoutHeight

type Error = Error

The type returned in the event of a conversion error.

fn try_from(raw_height: RawHeight) -> Result<Self, Self::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<RawHeight>) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for TimeoutHeight

impl Eq for TimeoutHeight

impl StructuralEq for TimeoutHeight

impl StructuralPartialEq for TimeoutHeight