Struct StringLimits 

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

Optional point limit for one UTF-8 string’s byte length.

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::ResourceLimit;
use qubit_budget::StringLimits;

let limits = StringLimits::builder()
    .utf8_bytes_limit(ResourceLimit::new("name bytes", 5_u64))
    .build();
limits.check("hello").expect("five UTF-8 bytes should fit");
assert!(limits.check("hello!").is_err());

Implementations

impl<R, Q> StringLimits<R, Q>

where Q: ResourceQuantity,

pub const fn new() -> Self

Creates limits with no configured string bound.

Returns

Creates limits with no configured string bound.

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

Creates a builder for string limits.

Returns

Creates a builder for string limits.

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

Converts these limits into a builder for further configuration.

Returns

Converts these limits into a builder for further configuration.

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

Returns the configured UTF-8 byte limit, if any.

Returns

Returns the configured UTF-8 byte limit, if any.

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

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

where R: Clone,

Checks one string without mutating the limits.

The measured quantity is the string’s UTF-8 byte length. A configured limit returns a point budget error when the length is too large.

Parameters

• value - UTF-8 string whose byte length is compared with the limit.

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 StringLimits<R, Q>

where Q: ResourceQuantity + Clone,

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

where Q: ResourceQuantity + Copy,

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

where Q: ResourceQuantity,

fn default() -> Self

Creates unconfigured string limits.

Returns

Creates unconfigured string limits.

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

where Q: ResourceQuantity + Eq,

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

where Q: ResourceQuantity + PartialEq,

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

Equality operator ==.

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

Inequality operator !=.

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

where Q: ResourceQuantity + PartialEq,