Struct JsonEncodeLimits 

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

Available on crate feature json only.

Optional limits for one JSON encoding session.

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::json::JsonEncodeLimits;

let limits = JsonEncodeLimits::builder().max_output_bytes(128_usize).max_depth(4_usize).build();
assert_eq!(limits.max_output_bytes(), Some(128));
assert_eq!(limits.value_limits().max_depth(), Some(4));

Implementations

impl<R, Q> JsonEncodeLimits<R, Q>

where Q: ResourceQuantity,

pub const fn new() -> Self

Creates an empty encoding limit set with no configured resource limits.

Returns

Creates an empty encoding limit set with no configured resource limits.

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

Creates a builder for JSON encoding limits.

Returns

Creates a builder for JSON encoding limits.

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

Converts these limits into a builder for further configuration.

Returns

Converts these limits into a builder for further configuration.

pub const fn has_limits(&self) -> bool

Returns whether any encoding or nested value limit is configured.

Returns

true when the output limit or at least one nested value limit is configured; otherwise false.

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

Returns the complete output-byte limit, when configured.

Returns

Returns the complete output-byte limit, when configured.

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

pub const fn value_limits(&self) -> &JsonValueLimits<R, Q>

Borrows the JSON value limits used for encoding.

Returns

Borrows the JSON value limits used for encoding.

pub fn into_value_limits(self) -> JsonValueLimits<R, Q>

Consumes these encoding limits and returns their JSON value limits.

Returns

Consumes these encoding limits and returns their JSON value limits.

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

Returns the configured output-byte maximum.

Returns

Returns the configured output-byte maximum.

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

Trait Implementations

impl<R: Clone, Q> Clone for JsonEncodeLimits<R, Q>

where Q: ResourceQuantity + Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R: Copy, Q> Copy for JsonEncodeLimits<R, Q>

where Q: ResourceQuantity + Copy,

impl<R: Debug, Q> Debug for JsonEncodeLimits<R, Q>

where Q: ResourceQuantity + Debug,

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

Formats the value using the given formatter.

impl<R, Q> Default for JsonEncodeLimits<R, Q>

where Q: ResourceQuantity,

fn default() -> Self

Creates encoding limits with every dimension unconfigured.

Returns

Creates encoding limits with every dimension unconfigured.

impl<R: Eq, Q> Eq for JsonEncodeLimits<R, Q>

where Q: ResourceQuantity + Eq,

impl<R: Hash, Q> Hash for JsonEncodeLimits<R, Q>

where Q: ResourceQuantity + Hash,

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<R: PartialEq, Q> PartialEq for JsonEncodeLimits<R, Q>

where Q: ResourceQuantity + PartialEq,

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

Equality operator ==.

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

Inequality operator !=.

impl<R: PartialEq, Q> StructuralPartialEq for JsonEncodeLimits<R, Q>

where Q: ResourceQuantity + PartialEq,