Enum TimeoutWindow 

pub enum TimeoutWindow {
    NoTimeout,
    Timeout {
        hard_timeout: BlockHeight,
        soft_timeout: BlockHeight,
    },
}

Variants

NoTimeout

Timeout

Fields

hard_timeout: BlockHeight

soft_timeout: BlockHeight

Implementations

impl TimeoutWindow

Creates a new timeout window with hard and soft timeout block heights.

This function automatically ensures that hard_timeout <= soft_timeout by swapping the parameters if they are provided in the wrong order. If the hard_timeout is greater than soft_timeout, the values will be swapped internally to maintain the invariant that hard timeout should occur before or at the same time as the soft timeout.

Parameters

• hard_timeout - The block height for the hard timeout (will be the earlier timeout)
• soft_timeout - The block height for the soft timeout (will be the later timeout)

Returns

A TimeoutWindow::Timeout variant with properly ordered timeout values.

pub fn timeout(hard_timeout: BlockHeight, soft_timeout: BlockHeight) -> Self

Trait Implementations

impl BorshDeserialize for TimeoutWindow

fn deserialize_reader<__R: Read>(reader: &mut __R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for TimeoutWindow

fn serialize<__W: Write>(&self, writer: &mut __W) -> Result<(), Error>

impl Clone for TimeoutWindow

fn clone(&self) -> TimeoutWindow

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for TimeoutWindow

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for TimeoutWindow

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

Formats the value using the given formatter.

impl Default for TimeoutWindow

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TimeoutWindow

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TimeoutWindow

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

Formats the value using the given formatter.

impl EnumExt for TimeoutWindow

fn deserialize_variant<__R: Read>( reader: &mut __R, variant_tag: u8, ) -> Result<Self, Error>

Deserialises given variant of an enum from the reader.

impl PartialEq for TimeoutWindow

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for TimeoutWindow

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.

impl Eq for TimeoutWindow

impl StructuralPartialEq for TimeoutWindow