Struct CommandArg 

pub struct CommandArg { /* private fields */ }

A validated command argument with sanitization

This newtype ensures that command arguments do not contain shell metacharacters that could lead to command injection attacks.

Implementations

impl CommandArg

pub fn new<S: AsRef<str>>(arg: S) -> Result<Self>

Create a new CommandArg from a string

Validation Rules

• Argument cannot contain shell metacharacters (;|&><$`\n\r)
• Argument can be empty (for flags like –release)

Examples

use ggen_utils::safe_command::CommandArg;

// Valid arguments
assert!(CommandArg::new("build").is_ok());
assert!(CommandArg::new("--release").is_ok());
assert!(CommandArg::new("").is_ok());

// Invalid arguments (shell metacharacters)
assert!(CommandArg::new("build; rm -rf /").is_err());
assert!(CommandArg::new("build | tee").is_err());
assert!(CommandArg::new("$(whoami)").is_err());

pub fn from_path(path: &SafePath) -> Self

Create a CommandArg from a SafePath

This ensures that path arguments are validated through SafePath.

Examples

use ggen_utils::safe_command::CommandArg;
use ggen_utils::safe_path::SafePath;

let path = SafePath::new("src/generated").unwrap();
let arg = CommandArg::from_path(&path);
assert_eq!(arg.as_str(), "src/generated");

pub fn as_str(&self) -> &str

Get the argument as a string slice

pub fn into_string(self) -> String

Convert into the inner String

Trait Implementations

impl Clone for CommandArg

fn clone(&self) -> CommandArg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandArg

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

Formats the value using the given formatter.

impl Display for CommandArg

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

Formats the value using the given formatter.

impl Eq for CommandArg

impl Hash for CommandArg

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 PartialEq for CommandArg

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CommandArg

impl TryFrom<&str> for CommandArg

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self>

Performs the conversion.

impl TryFrom<String> for CommandArg

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self>

Performs the conversion.