Struct Redacted 

pub struct Redacted<T, R = SimpleRedactor> { /* private fields */ }

A wrapper type for redacting values, so the actual values are not accidentally printed out.

A redacted value comes with a redaction strategy. The strategy provides the Display and Debug implementations for the inner type.

To access the redacted value proper, you must use the Redacted::unredact method.

Implementations

impl<T, R: Default> Redacted<T, R>

pub fn new(value: T) -> Self

Create a new redacted value with a Default redaction strategy.

use apollo_redaction::Redacted;
use apollo_redaction::strategy::SimpleRedactor;

let redacted = Redacted::<_, SimpleRedactor>::new("password for all the company's secrets");

impl<T, R> Redacted<T, R>

pub fn with_strategy(value: T, strategy: R) -> Self

Create a new redacted value with a redaction strategy.

impl<T, R> Redacted<T, R>

pub fn unredact(&self) -> &T

Access the underlying value.

pub fn unredact_mut(&mut self) -> &mut T

Access the underlying value.

Trait Implementations

impl<T: Clone, R: Clone> Clone for Redacted<T, R>

fn clone(&self) -> Redacted<T, R>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, R: RedactionStrategy<T>> Debug for Redacted<T, R>

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

Formats the value using the given formatter.

impl<T: Default, R: Default> Default for Redacted<T, R>

fn default() -> Redacted<T, R>

Returns the “default value” for a type.

impl<'de, T: Deserialize<'de>, R: Default> Deserialize<'de> for Redacted<T, R>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, R: RedactionStrategy<T>> Display for Redacted<T, R>

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

Formats the value using the given formatter.

impl<T, R: Default> From<T> for Redacted<T, R>

fn from(value: T) -> Self

Wrap a value in Redacted with a Default redaction strategy.

use apollo_redaction::Redacted;
use apollo_redaction::strategy::SimpleRedactor;

let redacted = Redacted::<_, SimpleRedactor>::from("password for all the company's secrets");

impl<T: FromStr, R: Default> FromStr for Redacted<T, R>

fn from_str(s: &str) -> Result<Self, Self::Err>

Parse a value from a string with a Default redaction strategy.

use apollo_redaction::Redacted;
use apollo_redaction::strategy::SimpleRedactor;
use url::Url;

let redacted: Redacted<Url, SimpleRedactor> = "https://apollographql.com".parse().expect("it's valid");

type Err = <T as FromStr>::Err

The associated error which can be returned from parsing.