Struct yamakan::Budget

pub struct Budget {
    pub amount: u64,
    pub consumption: u64,
}

Budget.

Fields

amount: u64

The amount of this budget.

consumption: u64

The consumption of this budget.

Note that this value can exceed the budget amount.

Methods

impl Budget

pub const fn new(amount: u64) -> Self

Makes a new Budget instance which has the given amount of budget.

pub fn remaining(&self) -> Result<u64, u64>

Returns the remaining amount of this budget.

Errors

If the consumption of the budget exceeded the budget amount, Err(excess amount) will be returned.

pub fn is_consumed(&self) -> bool

Returns true if the consumption has exceeded the budget amount, otherwise false.

Trait Implementations

impl Clone for Budget

fn clone(&self) -> Budget

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Budget

impl Debug for Budget

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

Formats the value using the given formatter.