Struct lock_keeper::infrastructure::sensitive_info::SensitiveInfoConfig

pub struct SensitiveInfoConfig {
    redact_sensitive_info: bool,
}

The SensitiveInfoConfig type is used to configure how we handle sensitive information (cryptographic keys, passwords, etc.) when using Display and Debug.

Fields

redact_sensitive_info: bool

A boolean indicating whether sensitive information should be redacted. If set to true, the sensitive information will be redacted (hidden or masked). If set to false, the sensitive information will not be redacted.

Implementations

impl SensitiveInfoConfig

const REDACTED_INFO_LABEL: &'static str = "***REDACTED***"

Tis is the label used to redact sensitive information in the library output

pub fn new(redact_sensitive_info: bool) -> Self

Constructor for SensitiveInfoConfig type. The default is to redact sensitive information in the output. Constructs a new instance of the type SensitiveInfoConfig

Arguments

• redact_sensitive_info - A boolean indicating whether to redact sensitive information. - When set to true, any sensitive information handled by instances using this configuration will be redacted (hidden or masked). - When set to false, the sensitive information will not be redacted.

Returns

• Returns a new instance of SensitiveInfoConfig, initialized with the provided redact_sensitive_info flag.

Example

use lock_keeper::infrastructure::sensitive_info::SensitiveInfoConfig;
let redact_sensitive_info = true;
let config = SensitiveInfoConfig::new(redact_sensitive_info);

pub fn redacted_label(self) -> String

Returns a label that is used in place of sensitive information.

pub fn redact(&mut self)

Redact sensitive information.

pub fn unredact(&mut self)

Unredact sensitive information.

pub fn is_redacted(&self) -> bool

Returns the status of the sensitive information redaction.

Trait Implementations

impl Clone for SensitiveInfoConfig

fn clone(&self) -> SensitiveInfoConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for SensitiveInfoConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for SensitiveInfoConfig

fn drop(&mut self)

Executes the destructor for this type.

impl PartialEq for SensitiveInfoConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SensitiveInfoConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<SensitiveInfoConfig> for Vec<u8>

Conversion from SensitiveInfoConfig to Vec<u8>

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from(config: SensitiveInfoConfig) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for SensitiveInfoConfig

Conversion from Vec<u8> to SensitiveInfoConfig

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from(bytes: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl Zeroize for SensitiveInfoConfig

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl Eq for SensitiveInfoConfig

impl StructuralPartialEq for SensitiveInfoConfig