Enum FutureEpoch 

#[repr(C)]
pub enum FutureEpoch<T> {
    None,
    One(T),
    Two(T),
}

Wrapper type that “counts down” epochs, which is Borsh-compatible with the native Option

Variants

None

Nothing is set

One(T)

Value is ready after the next epoch boundary

Two(T)

Value is ready after two epoch boundaries

Implementations

impl<T> FutureEpoch<T>

pub fn new(value: T) -> Self

Create a new value to be unlocked in a two epochs

impl<T: Clone> FutureEpoch<T>

pub fn update_epoch(&mut self)

Update the epoch, to be done after getting the underlying value

pub fn get(&self) -> Option<&T>

Get the value if it’s ready, which is only at One epoch remaining

Trait Implementations

impl<T> BorshDeserialize for FutureEpoch<T>

where T: BorshDeserialize,

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<T> BorshSchema for FutureEpoch<T>

where T: BorshSchema,

fn declaration() -> Declaration

Get the name of the type without brackets.

fn add_definitions_recursively( definitions: &mut BTreeMap<Declaration, Definition>, )

Recursively, using DFS, add type definitions required for this type. Type definition partially explains how to serialize/deserialize a type.

impl<T> BorshSerialize for FutureEpoch<T>

where T: BorshSerialize,

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

impl<T: Clone> Clone for FutureEpoch<T>

fn clone(&self) -> FutureEpoch<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for FutureEpoch<T>

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

Formats the value using the given formatter.

impl<T> Default for FutureEpoch<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> EnumExt for FutureEpoch<T>

where T: BorshDeserialize,

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

Deserialises given variant of an enum from the reader.

impl<T> From<FutureEpoch<T>> for Option<T>

fn from(v: FutureEpoch<T>) -> Option<T>

Converts to this type from the input type.

impl<T: PartialEq> PartialEq for FutureEpoch<T>

fn eq(&self, other: &FutureEpoch<T>) -> 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<T: Copy> Copy for FutureEpoch<T>

impl<T> StructuralPartialEq for FutureEpoch<T>