Skip to main content

MaskingPolicy

Struct MaskingPolicy 

Source
pub struct MaskingPolicy { /* private fields */ }
Expand description

Mask policies assigned to all supported sensitivity levels.

§Examples

use qubit_redact::MaskingPolicy;
use qubit_redact::Sensitivity;

let masking = MaskingPolicy::builder().build();
assert_eq!(masking.mask(Sensitivity::Secret, "raw"), "<redacted>");

Implementations§

Source§

impl MaskingPolicy

Source

pub fn builder() -> MaskingPolicyBuilder

Creates a builder initialized with the standard masking policies.

Source

pub fn mask<'a>(&self, level: Sensitivity, value: &'a str) -> Cow<'a, str>

Masks value with the policy configured for level.

Empty values remain empty; otherwise the selected policy determines whether the result borrows or owns its contents.

§Type Parameters
  • 'a - Lifetime of the input and any borrowed result.
§Parameters
  • level - Sensitivity level selecting the mask policy.
  • value - Value to mask.
§Returns

The borrowed empty input or an owned masked value.

Source

pub fn mask_opaque(&self, level: Sensitivity) -> &str

Returns the configured complete replacement for an opaque value.

This never reads the original value. Edge-preserving policies return only their replacement text because no prefix or suffix is safe to retain when the value is opaque.

§Parameters
  • level - Sensitivity level selecting the mask policy.
§Returns

The complete replacement configured for level.

Source

pub const fn for_level(&self, level: Sensitivity) -> &MaskPolicy

Returns the mask policy configured for level.

§Parameters
  • level - Sensitivity level to resolve.
§Returns

The mask policy assigned to level.

Trait Implementations§

Source§

impl Clone for MaskingPolicy

Source§

fn clone(&self) -> MaskingPolicy

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MaskingPolicy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MaskingPolicy

Source§

fn default() -> Self

Creates the built-in conservative four-level masking configuration.

§Returns

The built-in masking configuration.

Source§

impl Eq for MaskingPolicy

Source§

impl PartialEq for MaskingPolicy

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for MaskingPolicy

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.