Struct gear_core::reservation::GasReserver

pub struct GasReserver { /* private fields */ }

Gas reserver.

Controls gas reservations states.

Implementations

impl GasReserver

pub fn new( incoming_dispatch: &IncomingDispatch, map: GasReservationMap, max_reservations: u64, ) -> Self

Creates a new gas reserver.

map, which is a BTreeMap of GasReservationSlots, will be converted to the BTreeMap of GasReservationStates.

pub fn is_empty(&self) -> bool

Returns bool defining if gas reserver is empty.

pub fn limit_of(&self, reservation_id: &ReservationId) -> Option<u64>

Returns amount of gas in reservation, if exists.

pub fn reserve( &mut self, amount: u64, duration: u32, ) -> Result<ReservationId, ReservationError>

Reserves gas.

Creates a new reservation and returns its id.

Returns an error if maximum limit of reservations is reached.

pub fn unreserve( &mut self, id: ReservationId, ) -> Result<(u64, Option<UnreservedReimbursement>), ReservationError>

Unreserves gas reserved within id reservation.

Return error if:

1. Reservation doesn’t exist.
2. Reservation was “unreserved”, so in GasReservationState::Removed state.
3. Reservation was marked used.

pub fn mark_used(&mut self, id: ReservationId) -> Result<(), ReservationError>

Marks reservation as used.

This allows to avoid double usage of the reservation for sending a new message from execution of message_id of current gas reserver.

pub fn check_not_used( &mut self, id: ReservationId, ) -> Result<&mut bool, ReservationError>

Check if reservation is not used.

If reservation does not exist returns InvalidReservationId error.

pub fn nonce(&self) -> ReservationNonce

Returns gas reservations current nonce.

pub fn states(&self) -> &GasReservationStates

Gets gas reservations states.

pub fn into_map<F>( self, current_block_height: u32, duration_into_expiration: F, ) -> GasReservationMap

where F: Fn(u32) -> u32,

Converts current gas reserver into gas reservation map.

Trait Implementations

impl Clone for GasReserver

fn clone(&self) -> GasReserver

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GasReserver

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

Formats the value using the given formatter.

impl Decode for GasReserver

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl Encode for GasReserver

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl PartialEq for GasReserver

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

impl Eq for GasReserver

impl StructuralPartialEq for GasReserver