Enum PolicyError 

#[non_exhaustive]
pub enum PolicyError {
    EmptyFieldName {
        location: PolicyLocation,
    },
    EmptyFixedReplacement {
        location: PolicyLocation,
        level: Sensitivity,
    },
    OutputLimitTooLarge {
        maximum: usize,
    },
    SerdePayloadLimitTooLarge {
        maximum: usize,
    },
}

Error returned when a redaction policy contains an invalid rule.

Examples

use qubit_redact::{PolicyError, RedactionPolicy, Sensitivity};

let error = RedactionPolicy::builder()
    .fields(|fields| {
        fields.raise("", Sensitivity::Secret);
    })
    .expect_err("an empty field name is invalid");
assert!(matches!(error, PolicyError::EmptyFieldName { .. }));

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.

EmptyFieldName

A supplied field name is empty after canonicalization.

Fields

location: PolicyLocation

Location where the invalid field was configured.

EmptyFixedReplacement

A fixed mask has an empty replacement at the indicated level.

Fields

location: PolicyLocation

Location where the fixed mask was configured.

level: Sensitivity

Sensitivity level containing the invalid fixed mask.

OutputLimitTooLarge

The configured output ceiling cannot be represented by Rust’s collection allocators on this platform.

Fields

maximum: usize

Rejected configured output limit.

SerdePayloadLimitTooLarge

The logical Serde payload ceiling exceeds addressable capacity.

Fields

maximum: usize

Rejected configured scalar payload limit.

Trait Implementations

impl Clone for PolicyError

fn clone(&self) -> PolicyError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PolicyError

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

Formats the value using the given formatter.

impl Display for PolicyError

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

Formats a concise description of the invalid policy configuration.

Parameters

• formatter - Destination formatting context.

Returns

The formatter result from writing the error description.

Errors

Returns fmt::Error when the destination rejects a write.

impl Eq for PolicyError

impl Error for PolicyError

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

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PolicyError