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 HashMap of GasReservationStates.

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, 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 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.