Skip to main content

LogSanitizer

qubit_http

Struct LogSanitizer 

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

Applies a LogSanitizePolicy to URLs, headers, and body previews.

Implementations§

Source§

impl LogSanitizer

Source

pub fn new(policy: LogSanitizePolicy) -> Self

Creates a sanitizer from an explicit policy.

§Parameters
  • policy: Sanitization rules.
§Returns

New LogSanitizer.

Source

pub fn policy(&self) -> &LogSanitizePolicy

Returns the underlying policy.

§Returns

Borrowed policy.

Source

pub fn sanitize_url(&self, url: &Url) -> String

Returns a log-safe URL string with sensitive URL components masked.

§Parameters
  • url: URL to render.
§Returns

Sanitized URL string.

Source

pub fn sanitize_header_value( &self, name: &HeaderName, value: &HeaderValue, ) -> String

Returns a log-safe header value.

§Parameters
  • name: Header name.
  • value: Header value.
§Returns

Masked value for sensitive headers, original value for non-sensitive UTF-8 values, or <non-utf8> when header value is not valid UTF-8.

Source

pub fn sanitize_request_body_preview( &self, body: &[u8], limit: usize, content_type: Option<&str>, ) -> String

Returns a log-safe request body preview.

§Parameters
  • body: Source request body bytes.
  • limit: Maximum preview bytes; values below 1 are clamped to 1.
  • content_type: Optional Content-Type header used for structured redaction.
§Returns

Sanitized request body preview with request-style truncation suffix.

Source

pub fn sanitize_response_body_preview( &self, body: &[u8], limit: usize, content_type: Option<&str>, ) -> String

Returns a log-safe response body preview.

§Parameters
  • body: Source response body bytes.
  • limit: Maximum preview bytes; values below 1 are clamped to 1.
  • content_type: Optional Content-Type header used for structured redaction.
§Returns

Sanitized response body preview with response-style truncation suffix.

Source

pub fn sanitize_error_response_body_preview( &self, body: &[u8], limit: usize, content_type: Option<&str>, ) -> String

Returns a log-safe status-error body preview.

§Parameters
  • body: Source non-success response body bytes.
  • limit: Maximum preview bytes; values below 1 are clamped to 1.
  • content_type: Optional Content-Type header used for structured redaction.
§Returns

Sanitized error body preview with status-error truncation suffix.

Trait Implementations§

Source§

impl Clone for LogSanitizer

Source§

fn clone(&self) -> LogSanitizer

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 LogSanitizer

Source§

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

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

impl Default for LogSanitizer

Source§

fn default() -> Self

Creates a sanitizer using LogSanitizePolicy::default.

Source§

impl PartialEq for LogSanitizer

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for LogSanitizer

Source§

impl StructuralPartialEq for LogSanitizer

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, D> IntoConfigDefault<T> for D
where D: IntoValueDefault<T>,

Source§

fn into_config_default(self) -> T

Converts this fallback value into T.
Source§

impl<T> IntoResult<T> for T

Source§

type Err = Infallible

Source§

fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>

Source§

impl<T> IntoValueDefault<T> for T

Source§

fn into_value_default(self) -> T

Converts this argument into the default value.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more