Skip to main content

StructureLimits

qubit_budget::structure

Struct StructureLimits

pub struct StructureLimits<R = StructureResource, Q = usize>where
    Q: ResourceQuantity,
{ /* private fields */ }

Expand description

Optional limits for processing nested structural data.

R identifies the resource values reported in crate::BudgetError, and Q is the exact unsigned quantity used for all measurements. The default configuration uses StructureResource and usize.

§Type Parameters

R - Caller-defined resource identity retained by limits and errors.
Q - Exact unsigned quantity used for measurements and accounting.

§Examples

use qubit_budget::StructureLimits;

let limits = StructureLimits::builder()
    .max_depth(4)
    .max_nodes(16)
    .build();
let mut budget = limits.budget();

budget.check_depth(4).expect("the inclusive depth limit should fit");
budget.charge_node().expect("the first node should fit");
assert_eq!(budget.used_nodes(), Some(1));

Implementations§

impl<R, Q> StructureLimits<R, Q>
where Q: ResourceQuantity,

pub const fn new() -> Self

Creates an unconfigured custom-resource limit set.

The default StructureResource/usize configuration is constructed with Self::new. Custom resource sets use this constructor because their resource identity is supplied by each *_limit method.

§Returns

Creates an unconfigured custom-resource limit set.

pub const fn builder() -> StructureLimitsBuilder<R, Q>

Creates a builder for structural limits.

§Returns

Creates a builder for structural limits.

pub const fn into_builder(self) -> StructureLimitsBuilder<R, Q>

Converts these limits into a builder for further configuration.

§Returns

Converts these limits into a builder for further configuration.

pub fn to_builder(&self) -> StructureLimitsBuilder<R, Q>
where R: Clone,

Creates a builder by cloning this limit configuration.

Unlike Self::into_builder, this method leaves the original limits available for reuse.

§Returns

A builder initialized with a clone of every configured limit.

pub const fn has_limits(&self) -> bool

Returns whether any structural limit is configured.

§Returns

true when at least one structural dimension has a finite limit; otherwise false.

pub const fn depth_limit(&self) -> Option<&ResourceLimit<R, Q>>

Returns the complete depth limit, when configured.

§Returns

Returns the complete depth limit, when configured.

None indicates that the corresponding limit or budget dimension is unconfigured.

pub const fn nodes_limit(&self) -> Option<&ResourceLimit<R, Q>>

Returns the complete node limit, when configured.

§Returns

Returns the complete node limit, when configured.

None indicates that the corresponding limit or budget dimension is unconfigured.

pub const fn sequence_items_limit(&self) -> Option<&ResourceLimit<R, Q>>

Returns the complete sequence-item limit, when configured.

§Returns

Returns the complete sequence-item limit, when configured.

None indicates that the corresponding limit or budget dimension is unconfigured.

pub const fn map_entries_limit(&self) -> Option<&ResourceLimit<R, Q>>

Returns the complete map-entry limit, when configured.

§Returns

Returns the complete map-entry limit, when configured.

None indicates that the corresponding limit or budget dimension is unconfigured.

pub const fn key_bytes_limit(&self) -> Option<&ResourceLimit<R, Q>>

Returns the complete structural-key limit, when configured.

§Returns

Returns the complete structural-key limit, when configured.

None indicates that the corresponding limit or budget dimension is unconfigured.

pub const fn max_depth(&self) -> Option<Q>

Returns the configured maximum nesting depth.

§Returns

Returns the configured maximum nesting depth.

None indicates that the corresponding limit or budget dimension is unconfigured.

pub const fn max_nodes(&self) -> Option<Q>

Returns the configured maximum number of processed nodes.

§Returns

Returns the configured maximum number of processed nodes.

None indicates that the corresponding limit or budget dimension is unconfigured.

pub const fn max_sequence_items(&self) -> Option<Q>

Returns the configured maximum number of items in one sequence.

§Returns

Returns the configured maximum number of items in one sequence.

None indicates that the corresponding limit or budget dimension is unconfigured.

pub const fn max_map_entries(&self) -> Option<Q>

Returns the configured maximum number of entries in one map.

§Returns

Returns the configured maximum number of entries in one map.

None indicates that the corresponding limit or budget dimension is unconfigured.

pub const fn max_key_bytes(&self) -> Option<Q>

Returns the configured maximum byte length of one structural key.

§Returns

Returns the configured maximum byte length of one structural key.

None indicates that the corresponding limit or budget dimension is unconfigured.

pub fn budget(&self) -> StructureBudget<R, Q>
where R: Clone,

Creates an independent structural budget session from these limits.

§Returns

Creates an independent structural budget session from these limits.

Trait Implementations§

impl<R: Clone, Q> Clone for StructureLimits<R, Q>
where Q: ResourceQuantity + Clone,

fn clone(&self) -> StructureLimits<R, Q>

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

impl<R: Copy, Q> Copy for StructureLimits<R, Q>
where Q: ResourceQuantity + Copy,

impl<R: Debug, Q> Debug for StructureLimits<R, Q>
where Q: ResourceQuantity + Debug,

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

Formats the value using the given formatter. Read more

impl<R, Q> Default for StructureLimits<R, Q>
where Q: ResourceQuantity,

fn default() -> Self

Creates structural limits with every dimension unconfigured.

§Returns

Creates structural limits with every dimension unconfigured.

impl<R: Eq, Q> Eq for StructureLimits<R, Q>
where Q: ResourceQuantity + Eq,

impl<R, Q> From<StructureLimitsBuilder<R, Q>> for StructureLimits<R, Q>
where Q: ResourceQuantity,

fn from(builder: StructureLimitsBuilder<R, Q>) -> Self

Finishes the builder and returns its structural limit configuration.

§Parameters

builder - Builder whose accumulated configuration is consumed.

§Returns

Finishes the builder and returns its structural limit configuration.

impl<R: Hash, Q> Hash for StructureLimits<R, Q>
where Q: ResourceQuantity + Hash,

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

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more

impl<R: PartialEq, Q> PartialEq for StructureLimits<R, Q>
where Q: ResourceQuantity + PartialEq,

fn eq(&self, other: &StructureLimits<R, Q>) -> bool

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl<R: PartialEq, Q> StructuralPartialEq for StructureLimits<R, Q>
where Q: ResourceQuantity + PartialEq,

Auto Trait Implementations§

impl<R, Q> Freeze for StructureLimits<R, Q>
where Option<ResourceLimit<R, Q>>: Freeze,

impl<R, Q> RefUnwindSafe for StructureLimits<R, Q>
where Option<ResourceLimit<R, Q>>: RefUnwindSafe,

impl<R, Q> Send for StructureLimits<R, Q>
where Option<ResourceLimit<R, Q>>: Send,

impl<R, Q> Sync for StructureLimits<R, Q>
where Option<ResourceLimit<R, Q>>: Sync,

impl<R, Q> Unpin for StructureLimits<R, Q>
where Option<ResourceLimit<R, Q>>: Unpin,

impl<R, Q> UnsafeUnpin for StructureLimits<R, Q>
where Option<ResourceLimit<R, Q>>: UnsafeUnpin,

impl<R, Q> UnwindSafe for StructureLimits<R, Q>
where Option<ResourceLimit<R, Q>>: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.