Struct ResourceController

pub struct ResourceController<Account = Amount, Tracker = ResourceTracker> {
    pub policy: Arc<ResourceControlPolicy>,
    pub tracker: Tracker,
    pub account: Account,
}

Fields

policy: Arc<ResourceControlPolicy>

The (fixed) policy used to charge fees and control resource usage.

tracker: Tracker

How the resources were used so far.

account: Account

The account paying for the resource usage.

Implementations

impl<Account, Tracker> ResourceController<Account, Tracker>

where Account: BalanceHolder, Tracker: AsRef<ResourceTracker> + AsMut<ResourceTracker>,

pub fn balance(&self) -> Result<Amount, ArithmeticError>

Obtains the balance of the account. The only possible error is an arithmetic overflow, which should not happen in practice due to final token supply.

pub fn merge_balance( &mut self, initial: Amount, other: Amount, ) -> Result<(), ExecutionError>

Operates a 3-way merge by transferring the difference between initial and other to self.

pub fn track_grant(&mut self, grant: Amount) -> Result<(), ExecutionError>

Tracks the allocation of a grant.

pub fn track_block(&mut self) -> Result<(), ExecutionError>

Tracks the creation of a block.

pub fn track_operation( &mut self, operation: &Operation, ) -> Result<(), ExecutionError>

Tracks the execution of an operation in block.

pub fn track_message(&mut self, message: &Message) -> Result<(), ExecutionError>

Tracks the creation of an outgoing message.

pub fn track_http_request(&mut self) -> Result<(), ExecutionError>

Tracks the execution of an HTTP request.

pub fn track_blob_published( &mut self, content: &BlobContent, ) -> Result<(), ExecutionError>

Tracks a number of blob bytes published.

impl<Account, Tracker> ResourceController<Account, Tracker>

where Tracker: AsMut<ResourceTracker>,

pub fn track_block_size_of( &mut self, data: &impl Serialize, ) -> Result<(), ExecutionError>

Tracks the serialized size of a block, or parts of it.

pub fn track_block_size(&mut self, size: usize) -> Result<(), ExecutionError>

Tracks the serialized size of a block, or parts of it.

impl ResourceController<Option<AccountOwner>, ResourceTracker>

pub async fn with_state<'a, C>( &mut self, view: &'a mut SystemExecutionStateView<C>, ) -> Result<ResourceController<Sources<'a>, &mut ResourceTracker>, ViewError>

where C: Context + Clone + Send + Sync + 'static,

Provides a reference to the current execution state and obtains a temporary object where the accounting functions of ResourceController are available.

pub async fn with_state_and_grant<'a, C>( &mut self, view: &'a mut SystemExecutionStateView<C>, grant: Option<&'a mut Amount>, ) -> Result<ResourceController<Sources<'a>, &mut ResourceTracker>, ViewError>

where C: Context + Clone + Send + Sync + 'static,

Provides a reference to the current execution state as well as an optional grant, and obtains a temporary object where the accounting functions of ResourceController are available.

Trait Implementations

impl<Account: Clone, Tracker: Clone> Clone for ResourceController<Account, Tracker>

fn clone(&self) -> ResourceController<Account, Tracker>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Account, Tracker> Debug for ResourceController<Account, Tracker>

where Tracker: Debug, Account: Debug,

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

Formats the value using the given formatter.

impl<Account: Default, Tracker: Default> Default for ResourceController<Account, Tracker>

fn default() -> ResourceController<Account, Tracker>

Returns the “default value” for a type.