Skip to main content

ArgvRedactor

Struct ArgvRedactor 

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

Applies one immutable redaction policy to argument vectors.

Implementations§

Source§

impl ArgvRedactor

Source

pub const fn new(redactor: Redactor) -> Self

Creates an argv redactor from a core redactor.

§Parameters
  • redactor - Core redactor whose immutable policy will be used.
§Returns

An argv redactor owning the supplied policy snapshot.

Source

pub const fn redactor(&self) -> &Redactor

Returns the core redactor backing this adapter.

§Returns

A borrowed view of the core redactor.

Source

pub fn redact_items<'a, I>(&self, items: I) -> RedactedArgv
where I: IntoIterator<Item = ArgvItem<'a>>,

Redacts only values explicitly marked sensitive by their caller.

Plain items are rendered as ordinary argv values without guessing whether they are options, assignments, or option values. Non-UTF-8 sensitive items are masked from an opaque sentinel so their original bytes can never reach output.

§Type Parameters
  • 'a - Lifetime of argument values borrowed by the iterator.
  • I - Iterator source yielding borrowed ArgvItem values.
§Parameters
  • items - Borrowed argv items with optional authoritative levels.
§Returns

A log-safe rendering in input order.

Source

pub fn redact_heuristically<'a, I>(&self, items: I) -> RedactedArgv
where I: IntoIterator<Item = ArgvItem<'a>>,

Redacts explicit sensitive values and heuristically classified plain values.

Explicit sensitivity always wins. Plain items recognize --name value, --name=value, -name value, NAME=value, and JVM-style -Dname=value properties. Compact options such as -pSECRET and shell payload syntax are not inferred. Callers must mark those values explicitly when they are sensitive. Because this is a safety heuristic rather than a command-specific parser, an option delimiter does not disable recognition in later wrapper or child-command segments. A non-UTF-8 plain item is masked at Sensitivity::Secret because it cannot be classified safely.

§Type Parameters
  • 'a - Lifetime of argument values borrowed by the iterator.
  • I - Iterator source yielding borrowed ArgvItem values.
§Parameters
  • items - Borrowed argv items with optional authoritative levels.
§Returns

A log-safe rendering in input order.

Source

pub fn redact_items_with_session<'a, I>( &self, items: I, session: &RedactionSession<'_>, ) -> RedactedArgv
where I: IntoIterator<Item = ArgvItem<'a>>,

Redacts explicit items while sharing cumulative input and output accounting with other diagnostic adapters.

Source

pub fn redact_heuristically_with_session<'a, I>( &self, items: I, session: &RedactionSession<'_>, ) -> RedactedArgv
where I: IntoIterator<Item = ArgvItem<'a>>,

Redacts explicit and heuristic items through a shared diagnostic session.

Trait Implementations§

Source§

impl Clone for ArgvRedactor

Source§

fn clone(&self) -> ArgvRedactor

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 ArgvRedactor

Source§

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

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

impl Default for ArgvRedactor

Source§

fn default() -> Self

Creates an argv redactor from the current default policy snapshot.

§Returns

An argv redactor backed by Redactor::default.

Source§

impl Eq for ArgvRedactor

Source§

impl PartialEq for ArgvRedactor

Source§

fn eq(&self, other: &ArgvRedactor) -> 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 ArgvRedactor

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.