Struct FileTypeProfile 

pub struct FileTypeProfile {
    pub processor: String,
    pub extensions: Vec<String>,
    pub fields: Vec<FieldRule>,
    pub options: HashMap<String, String>,
}

Specifies which processor to use and what fields to sanitize.

Example (serialized as JSON)

{
  "processor": "key_value",
  "extensions": [".rb", ".conf"],
  "fields": [
    { "pattern": "*.password", "category": "custom:password" },
    { "pattern": "*.secret",   "category": "custom:secret"   },
    { "pattern": "smtp_address", "category": "hostname" }
  ],
  "options": {
    "delimiter": "=",
    "comment_prefix": "#"
  }
}

Fields

processor: String

Name of the processor to use (e.g. "key_value", "json").

extensions: Vec<String>

File extensions this profile applies to (e.g. [".rb", ".conf"]).

fields: Vec<FieldRule>

Field rules: which keys/paths to sanitize.

options: HashMap<String, String>

Free-form options passed to the processor (e.g. delimiter, comment chars).

Implementations

impl FileTypeProfile

pub fn new(processor: impl Into<String>, fields: Vec<FieldRule>) -> Self

Create a minimal profile for a given processor.

pub fn with_extension(self, ext: impl Into<String>) -> Self

Add an extension to this profile.

pub fn with_option( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add a free-form option.

pub fn matches_filename(&self, filename: &str) -> bool

Check whether a filename matches this profile’s extensions.

Returns false if the profile has no extensions.

Examples

use sanitize_engine::processor::profile::FieldRule;
use sanitize_engine::processor::profile::FileTypeProfile;

let profile = FileTypeProfile::new("json", vec![])
    .with_extension(".json")
    .with_extension(".jsonc");

assert!(profile.matches_filename("config.json"));
assert!(profile.matches_filename("deep/path/app.jsonc"));
assert!(!profile.matches_filename("config.yml"));
assert!(!FileTypeProfile::new("json", vec![]).matches_filename("any.json"));

Trait Implementations

impl Clone for FileTypeProfile

fn clone(&self) -> FileTypeProfile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileTypeProfile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileTypeProfile

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FileTypeProfile

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

where __S: Serializer,

Serialize this value into the given Serde serializer.