Struct BigIntegerLimits 

pub struct BigIntegerLimits<R, Q = u64>
where
    Q: ResourceQuantity,
{ /* private fields */ }

Available on crate feature big-integer only.

Optional point limits for one arbitrary-precision integer.

Type Parameters

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

Examples

use num_bigint::BigInt;
use qubit_budget::BigIntegerLimits;
use qubit_budget::ResourceLimit;

let limits = BigIntegerLimits::builder()
    .magnitude_bits_limit(ResourceLimit::new("integer bits", 8_u64))
    .build();
limits.check(&BigInt::from(255_u16)).expect("255 needs eight bits");

Implementations

impl<R, Q> BigIntegerLimits<R, Q>

where Q: ResourceQuantity,

pub const fn new() -> Self

Creates limits with no configured integer bounds.

Returns

Creates limits with no configured integer bounds.

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

Creates a builder for integer limits.

Returns

Creates a builder for integer limits.

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

Converts these limits into a builder for further configuration.

Returns

Converts these limits into a builder for further configuration.

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

Returns the configured magnitude bit-length limit, if any.

Returns

Returns the configured magnitude bit-length limit, if any.

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

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

Returns the configured significant decimal digit limit, if any.

Returns

Returns the configured significant decimal digit limit, if any.

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

pub fn check(&self, value: &BigInt) -> Result<(), MeasuredBudgetError<R, Q>>

where R: Clone,

Checks one integer without formatting clearly oversized values.

Values near the decimal boundary are formatted once. Clearly oversized values report a conservative lower bound instead of allocating a decimal string proportional to the input magnitude.

Parameters

• value - Arbitrary-precision integer whose magnitude and decimal digit counts are compared with the configured limits.

Returns

Ok(()) when the operation completes successfully.

Errors

Returns MeasuredBudgetError when a native measurement cannot fit Q or a configured limit rejects it.

Trait Implementations

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

where Q: ResourceQuantity + Clone,

fn clone(&self) -> BigIntegerLimits<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 BigIntegerLimits<R, Q>

where Q: ResourceQuantity + Copy,

impl<R: Debug, Q> Debug for BigIntegerLimits<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 BigIntegerLimits<R, Q>

where Q: ResourceQuantity,

fn default() -> Self

Creates unconfigured integer limits.

Returns

Creates unconfigured integer limits.

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

where Q: ResourceQuantity + Eq,

impl<R: Hash, Q> Hash for BigIntegerLimits<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 BigIntegerLimits<R, Q>

where Q: ResourceQuantity + PartialEq,

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

Equality operator ==.

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

Inequality operator !=.

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

where Q: ResourceQuantity + PartialEq,