Struct RedactionRule 

pub struct RedactionRule {
    pub pattern: Option<String>,
    pub match_mode: Option<i32>,
    pub keep_full: Option<bool>,
    pub replacement_name: Option<String>,
    pub keep_file_extension: Option<bool>,
    pub keep_path_elements: Option<u32>,
}

Fields

pattern: Option<String>

The pattern to match against.

match_mode: Option<i32>

keep_full: Option<bool>

If the pattern matches, keep the entire name. In other words, do not redact. This option exists since the rules are evaluated in order, so a more specific allow rule with keep_full can match before a more general deny rule. This option is mutually exclusive with |keep_file_extension| and |keep_path_elements|.

replacement_name: Option<String>

If the pattern matches, replace the name with this string (defaulting to <pf_redacted> if unset). The final emitted name might be further augmented by the options below keeping parts of the original name.

keep_file_extension: Option<bool>

If the pattern matches, keep the file extension, if any. Can be combined with |keep_path_elements|.

keep_path_elements: Option<u32>

If the pattern matches, keep the first N path elements (as separated by ‘/’). If the name is not a path, this option does nothing. Can be combined with |keep_file_extension|.

Implementations

impl RedactionRule

pub fn pattern(&self) -> &str

Returns the value of pattern, or the default value if pattern is unset.

pub fn match_mode(&self) -> MatchMode

Returns the enum value of match_mode, or the default if the field is unset or set to an invalid enum value.

pub fn set_match_mode(&mut self, value: MatchMode)

Sets match_mode to the provided enum value.

pub fn keep_full(&self) -> bool

Returns the value of keep_full, or the default value if keep_full is unset.

pub fn replacement_name(&self) -> &str

Returns the value of replacement_name, or the default value if replacement_name is unset.

pub fn keep_file_extension(&self) -> bool

Returns the value of keep_file_extension, or the default value if keep_file_extension is unset.

pub fn keep_path_elements(&self) -> u32

Returns the value of keep_path_elements, or the default value if keep_path_elements is unset.

Trait Implementations

impl Clone for RedactionRule

fn clone(&self) -> RedactionRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RedactionRule

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

Formats the value using the given formatter.

impl Default for RedactionRule

fn default() -> Self

Returns the “default value” for a type.

impl Hash for RedactionRule

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for RedactionRule

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for RedactionRule

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for RedactionRule

impl StructuralPartialEq for RedactionRule