Skip to main content

UrlPasswordRedactor

Struct UrlPasswordRedactor 

Source
pub struct UrlPasswordRedactor;
Expand description

Redact the password component of a URL, preserving all other components.

If the URL contains a password component, it is replaced with ***. All other components — scheme, username, host, port, path, query, fragment — are preserved. The output is the URL as normalised by the url crate (for example, a trailing / may be added to URLs with an authority and no path, and an empty password is dropped entirely along with its : separator). If the input cannot be parsed as a URL, the output is [REDACTED: invalid URL].

use apollo_redaction::Redacted;
use apollo_redaction::strategy::UrlPasswordRedactor;

fn url(input: &str) -> String {
    Redacted::<_, UrlPasswordRedactor>::new(input).to_string()
}

assert_eq!(url("http://alice:s3cr3t@proxy.corp.example.com:3128/"), "http://alice:***@proxy.corp.example.com:3128/");
assert_eq!(url("postgres://user:hunter2@db.internal/app"), "postgres://user:***@db.internal/app");
assert_eq!(url("http://proxy.example.com:3128"), "http://proxy.example.com:3128/");
assert_eq!(url("not a url"), "[REDACTED: invalid URL]");

Trait Implementations§

Source§

impl Clone for UrlPasswordRedactor

Source§

fn clone(&self) -> UrlPasswordRedactor

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 Default for UrlPasswordRedactor

Source§

fn default() -> UrlPasswordRedactor

Returns the “default value” for a type. Read more
Source§

impl<T: AsRef<str>> RedactionStrategy<T> for UrlPasswordRedactor

Source§

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

How to redact the value for the Display ({}) implementation.
Source§

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

How to redact the value for the Debug ({:?}) implementation. By default, this delegates to RedactionStrategy::display.

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.