Enum ValidationError 

#[non_exhaustive]
pub enum ValidationError {
    DistanceOutOfRange {
        value: f32,
        valid: RangeInclusive<f32>,
    },
    DistanceNotFinite {
        value: f32,
    },
    EffortOutOfRange {
        value: u8,
        valid: RangeInclusive<u8>,
    },
    IterCountOutOfRange {
        name: &'static str,
        value: u32,
        valid: RangeInclusive<u32>,
    },
    QualityLoopMutuallyExclusive {
        first: &'static str,
        second: &'static str,
    },
    FineGrainedStepOutOfRange {
        value: u8,
        valid: RangeInclusive<u8>,
    },
    KInfoLossMulBaseInvalid {
        value: f32,
    },
    KAcQuantInvalid {
        value: f32,
    },
    NbRctsToTryOutOfRange {
        value: u8,
        valid: RangeInclusive<u8>,
    },
    WpNumParamSetsOutOfRange {
        value: u8,
        valid: RangeInclusive<u8>,
    },
    TreeMaxBucketsZero,
    TreeNumPropertiesOutOfRange {
        value: u8,
        valid: RangeInclusive<u8>,
    },
    TreeThresholdBaseInvalid {
        value: f32,
    },
    TreeSampleFractionOutOfRange {
        value: f32,
        valid: RangeInclusive<f32>,
    },
}

Errors produced by validate() on the public config types.

#[non_exhaustive] so new variants can land additively as we discover further invariants worth surfacing.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

DistanceOutOfRange

Butteraugli distance is outside the libjxl-supported range. libjxl rejects distances <= 0.0 (for lossy) and clamps the upper end to 25.0. 0.0 is mathematically lossless and is not accepted on LossyConfig; use LosslessConfig instead.

Fields

value: f32

valid: RangeInclusive<f32>

DistanceNotFinite

Distance was non-finite (NaN or infinity).

Fields

value: f32

EffortOutOfRange

Effort level outside 1..=10. (EffortProfile::lossy / lossless clamp internally; this surfaces the violation up front instead of silently coercing.)

Fields

value: u8

valid: RangeInclusive<u8>

IterCountOutOfRange

A quality-loop iteration count exceeds the encoder’s reasonable cap. libjxl uses up to 4 butteraugli iterations at kTortoise; we accept up to 16 across all loops to leave headroom for the tuning harness.

Fields

name: &'static str

value: u32

valid: RangeInclusive<u32>

QualityLoopMutuallyExclusive

Two or more quality loops are simultaneously requested. The lossy encoder runs at most one quality loop per encode (butteraugli, ssim2, or zensim) — picking which is the caller’s choice. Stacking is not a supported configuration.

Fields

first: &'static str

second: &'static str

FineGrainedStepOutOfRange

fine_grained_step outside 1..=8. 0 would cause the AC strategy search loop’s step_by(0) to panic.

Fields

value: u8

valid: RangeInclusive<u8>

KInfoLossMulBaseInvalid

k_info_loss_mul_base is non-finite or non-positive. The encoder multiplies pixel-domain error terms by this; non-positive values invert the cost model.

Fields

value: f32

KAcQuantInvalid

k_ac_quant is non-finite or non-positive. Used as the quantization-cost constant when materializing the initial quant field; non-positive values produce a zero/negative initial quant.

Fields

value: f32

NbRctsToTryOutOfRange

nb_rcts_to_try exceeds libjxl’s documented kTortoise schedule (19).

Fields

value: u8

valid: RangeInclusive<u8>

WpNumParamSetsOutOfRange

wp_num_param_sets exceeds the maximum number of WP modes the encoder iterates over (5).

Fields

value: u8

valid: RangeInclusive<u8>

TreeMaxBucketsZero

tree_max_buckets is zero — the histogram quantizer needs at least one bucket per property.

TreeNumPropertiesOutOfRange

tree_num_properties exceeds the property-order length (16, the size of PROP_ORDER_NO_SQUEEZE / PROP_ORDER_SQUEEZE in src/modular/tree_learn.rs).

Fields

value: u8

valid: RangeInclusive<u8>

TreeThresholdBaseInvalid

tree_threshold_base is non-finite or negative. libjxl’s formula is 75 + 14 * speed_tier; negative thresholds would accept every split.

Fields

value: f32

TreeSampleFractionOutOfRange

tree_sample_fraction is non-finite or outside 0.0..=1.0. It is a pixel-fraction sampler ratio.

Fields

value: f32

valid: RangeInclusive<f32>

Trait Implementations

impl Clone for ValidationError

fn clone(&self) -> ValidationError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValidationError

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

Formats the value using the given formatter.

impl Display for ValidationError

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

Formats the value using the given formatter.

impl Error for ValidationError

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.