Struct LogSafeText 

pub struct LogSafeText<'a>(/* private fields */);

Redacted text whose log-structure and bidirectional controls are escaped.

Values can only be constructed inside this crate after escaping, preventing arbitrary untrusted text from being labeled log-safe.

Type Parameters

• 'a - Lifetime of any borrowed escaped text stored by the value.

Implementations

impl<'a> LogSafeText<'a>

pub fn as_str(&self) -> &str

Borrows the escaped log-safe contents.

Returns

The escaped text without allocating or formatting it.

pub fn into_owned(self) -> String

Converts this value into an owned escaped string.

Returns

The existing string allocation when this value already owns its contents, or a copied string for borrowed contents.

pub const fn with_output_limit( &self, limit: LogOutputLimit, ) -> BoundedLogSafeDisplay<'_>

Creates a display adapter bounded by one final log-output limit.

Parameters

• limit - Validated final output-byte limit.

Returns

A bounded adapter borrowing this escaped text.

Trait Implementations

impl AsRef<str> for LogSafeText<'_>

fn as_ref(&self) -> &str

Borrows the escaped log-safe contents.

Returns

The escaped text as a string slice.

impl<'a> Clone for LogSafeText<'a>

fn clone(&self) -> LogSafeText<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for LogSafeText<'a>

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

Formats the value using the given formatter.

impl Display for LogSafeText<'_>

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

Writes the already escaped contents without surrounding quotes.

Parameters

• formatter - Destination formatting context.

Returns

The formatter result from writing the complete escaped string.

Errors

Returns fmt::Error when the destination formatter cannot accept the complete escaped string.

impl<'a> Eq for LogSafeText<'a>

impl<'a> PartialEq for LogSafeText<'a>

fn eq(&self, other: &LogSafeText<'a>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for LogSafeText<'a>