Struct AutoNameSettings 

pub struct AutoNameSettings { /* private fields */ }

Controls in detail which parts of the command are automatically captured as the process name.

Process names are used in public error messages and tracing fields. Only capture arguments, environment variables, or current directories when those values are safe to log. Use AutoNameSettings::builder to opt into custom combinations; the builder defaults to capturing only the program name.

Implementations

impl AutoNameSettings

pub fn builder() -> AutoNameSettingsBuilder<((), (), ())>

Create a builder for building AutoNameSettings. On the builder, call .include_current_dir(...)(optional), .include_envs(...)(optional), .include_args(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of AutoNameSettings.

impl AutoNameSettings

pub fn program_only() -> Self

Capture the program name.

Example: Command::new("ls").arg("-la").env("FOO", "foo) is captured as "ls".

pub fn program_with_args() -> Self

Capture the program name and all arguments.

Example: Command::new("ls").arg("-la").env("FOO", "foo) is captured as ls "-la".

Arguments may contain tokens, passwords, signed URLs, or headers. Use this only when arguments are safe to include in public errors and logs or for debugging purposes.

pub fn program_with_env_and_args() -> Self

Capture the program name and all environment variables and arguments.

Example: Command::new("ls").arg("-la").env("FOO", "foo) is captured as FOO=foo ls "-la".

Environment variables and arguments often contain credentials. Use this only when all captured values are safe to include in public errors and logs or for debugging purposes.

pub fn full() -> Self

Capture the directory and the program name and all environment variables and arguments.

Example: Command::new("ls").arg("-la").env("FOO", "foo) is captured as /some/dir % FOO=foo ls "-la".

Current directories, environment variables, and arguments may contain sensitive data. Use this only when all captured values are safe to include in public errors and logs.

Trait Implementations

impl Clone for AutoNameSettings

fn clone(&self) -> AutoNameSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AutoNameSettings

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

Formats the value using the given formatter.

impl Default for AutoNameSettings

fn default() -> Self

Returns the “default value” for a type.

impl From<AutoNameSettings> for AutoName

fn from(settings: AutoNameSettings) -> Self

Converts to this type from the input type.

impl From<AutoNameSettings> for ProcessName

fn from(settings: AutoNameSettings) -> Self

Converts to this type from the input type.

impl PartialEq for AutoNameSettings

fn eq(&self, other: &AutoNameSettings) -> 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 Copy for AutoNameSettings

impl Eq for AutoNameSettings

impl StructuralPartialEq for AutoNameSettings