Struct Budget 

pub struct Budget { /* private fields */ }

Time budget in the tropical semiring (min, +).

Budget decreases additively via consume and the constraint propagates as the minimum of parent and child budgets.

use franken_kernel::Budget;

let b = Budget::new(1000);
let b2 = b.consume(300).unwrap();
assert_eq!(b2.remaining_ms(), 700);
assert!(b2.consume(800).is_none()); // would exceed budget

Implementations

impl Budget

pub const UNLIMITED: Self

An unlimited budget (max u64 value).

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

Create a budget with the given milliseconds remaining.

pub const fn remaining_ms(self) -> u64

Milliseconds remaining.

pub const fn consume(self, ms: u64) -> Option<Self>

Consume ms milliseconds from the budget.

Returns None if insufficient budget remains.

pub const fn is_exhausted(self) -> bool

Whether the budget is fully exhausted.

pub const fn min(self, other: Self) -> Self

Tropical semiring min: returns the tighter (smaller) budget.

Trait Implementations

impl Clone for Budget

fn clone(&self) -> Budget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Budget

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Budget

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Budget

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Budget

fn cmp(&self, other: &Budget) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Budget

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

fn partial_cmp(&self, other: &Budget) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Budget

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Budget

impl Eq for Budget

impl StructuralPartialEq for Budget