Skip to main content

ResourceBudget

Struct ResourceBudget 

Source
#[non_exhaustive]
pub struct ResourceBudget { pub max_steps: Option<u64>, pub max_value_elements: Option<usize>, }
Expand description

Evaluator-side resource budget.

ResourceBudget is deliberately separate from Capabilities: capabilities answer “may the program use this host authority?”, while a budget answers “how much evaluator work/value growth is this host willing to pay for?”. The current implementation still stores these two fields on Capabilities for compatibility; call Self::apply_to_capabilities to bridge the new model into the existing evaluator.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§max_steps: Option<u64>

Maximum evaluator steps. None is unbounded.

§max_value_elements: Option<usize>

Maximum number of elements in a single List/Tuple/Dict. None is unbounded.

Implementations§

Source§

impl ResourceBudget

Source

pub const DEV_MAX_STEPS: u64 = 5_000_000

Source

pub const DEV_MAX_VALUE_ELEMENTS: usize = 100_000

Source

pub const UNTRUSTED_MAX_STEPS: u64 = 1_000_000

Source

pub const UNTRUSTED_MAX_VALUE_ELEMENTS: usize = 10_000

Source

pub fn off() -> Self

No evaluator-side budget.

Source

pub fn dev() -> Self

Local-development guardrails.

Source

pub fn untrusted() -> Self

Tighter evaluator guardrails for externally supplied source.

Source

pub fn from_profile(profile: ResourceBudgetProfile) -> Self

Source

pub fn has_evaluator_limits(self) -> bool

Source

pub fn apply_to_capabilities(self, caps: &mut Capabilities)

Trait Implementations§

Source§

impl Clone for ResourceBudget

Source§

fn clone(&self) -> ResourceBudget

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ResourceBudget

Source§

impl Debug for ResourceBudget

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ResourceBudget

Source§

fn default() -> ResourceBudget

Returns the “default value” for a type. Read more
Source§

impl Eq for ResourceBudget

Source§

impl PartialEq for ResourceBudget

Source§

fn eq(&self, other: &ResourceBudget) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for ResourceBudget

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.