Struct scrub_minidump::Cli

pub(crate) struct Cli {
    pub(crate) config: PathBuf,
    pub(crate) minidump: PathBuf,
    pub(crate) output: Option<PathBuf>,
}

Apply data scrubbing (PII) rules on a minidump file.

Remove all heap memory:

{"applications": {"$heap_memory": ["@anything:remove"]}}

Remove all memory regions:

{"applications": {"$stack_memory || $heap_memory": ["@anything:remove"]}}

Remove credit cards from heap memory:

{"applications": {"$heap_memory": ["@creditcard:remove"]}}

For more information on how to scrub IP addresses, user file paths and how to define custom regexes see https://getsentry.github.io/relay/pii-config/

Fields

config: PathBuf

Path to a PII config JSON file.

minidump: PathBuf

Path to the minidump to rewrite.

output: Option<PathBuf>

Optional output path. By default, the minidump file is overwritten.

Implementations

impl Cli

pub(crate) fn load_pii_config(&self) -> Result<PiiConfig>

pub(crate) fn load_minidump(&self) -> Result<Vec<u8>>

pub(crate) fn minidump_name(&self) -> &str

pub(crate) fn write_output(&self, data: &[u8]) -> Result<()>

pub fn run(self) -> Result<()>

Trait Implementations

impl Args for Cli

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can update self.

impl CommandFactory for Cli

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for Cli

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

Formats the value using the given formatter.

impl FromArgMatches for Cli

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Cli

fn parse() -> Self

Parse from std::env::args_os(), exit on error

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.