Struct JcsWorkingMemoryError 

pub struct JcsWorkingMemoryError { /* private fields */ }

Reports when JCS rendering needs more auxiliary memory than the configured limit.

The error records both byte counts without exposing the rendered value.

Examples

use qubit_budget::json::JsonEncodeLimits;
use qubit_json::encode::JcsEncoder;

let limits: JsonEncodeLimits = JsonEncodeLimits::new();
let mut encoder = JcsEncoder::with_limits(limits, 0);
let error = encoder
    .to_vec(&serde_json::json!({"key": "value"}))
    .expect_err("zero working memory cannot render an object");
let memory_error = error
    .working_memory_error()
    .expect("the failure is caused by the working memory limit");
assert_eq!(memory_error.limit(), 0);
assert!(memory_error.requested() > memory_error.limit());

Implementations

impl JcsWorkingMemoryError

pub const fn limit(&self) -> usize

Returns the configured working memory limit in bytes.

Returns

The maximum auxiliary memory available to the renderer.

pub const fn requested(&self) -> usize

Returns the requested working memory in bytes.

Returns

The auxiliary memory required by the rejected request.

Trait Implementations

impl Clone for JcsWorkingMemoryError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for JcsWorkingMemoryError

impl Debug for JcsWorkingMemoryError

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

Formats the value using the given formatter.

impl Display for JcsWorkingMemoryError

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

Formats the configured limit and rejected request for diagnostics.

Parameters

• formatter is the destination receiving the diagnostic text.

Returns

Ok(()) when formatting succeeds, or a formatting error if the destination rejects the output.

Errors

Returns the formatting error from the destination when it rejects output.

impl Eq for JcsWorkingMemoryError

impl Error for JcsWorkingMemoryError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl Hash for JcsWorkingMemoryError

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 PartialEq for JcsWorkingMemoryError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for JcsWorkingMemoryError