Struct ResourceLimits 

pub struct ResourceLimits {
    pub input_bytes: u64,
    pub bundle_entries: u64,
    pub graph_elements: u64,
    pub metadata_bytes: u64,
    pub depth: u64,
    pub steps: u64,
    pub output_bytes: u64,
}

What a single operation is allowed to consume.

Every field is a maximum. 0 means unbounded, which is a deliberate choice a Rust caller can make and which no FFI or command-line entry point selects by default: unbounded behaviour should be asked for, never inherited.

Fields

input_bytes: u64

Bytes of input accepted in one operation.

bundle_entries: u64

Documents in one bundle.

graph_elements: u64

Vertices, edges and nodes in a decoded schema or instance.

metadata_bytes: u64

Bytes of metadata attached to a schema or instance.

depth: u64

Levels of nesting descended.

steps: u64

Steps of evaluation or search performed.

output_bytes: u64

Bytes of output produced.

Implementations

impl ResourceLimits

pub const fn defaults() -> Self

The defaults every untrusted public surface uses.

Chosen to admit any document a person would plausibly author while refusing one built to exhaust a machine. The depth bound matches the walk and extraction depths that already existed, so this changes no behaviour those already governed.

pub const fn unbounded() -> Self

No bound on anything.

For a Rust caller processing input it produced itself. Reaching for this at a boundary that accepts input from elsewhere is what this type exists to prevent.

pub const fn get(&self, resource: Resource) -> u64

The bound configured for resource.

pub fn budget(self) -> Budget

Start a budget against these limits.

Trait Implementations

impl Clone for ResourceLimits

fn clone(&self) -> ResourceLimits

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ResourceLimits

impl Debug for ResourceLimits

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

Formats the value using the given formatter.

impl Default for ResourceLimits

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ResourceLimits

impl PartialEq for ResourceLimits

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ResourceLimits