Skip to main content

AddArgs

Struct AddArgs 

Source
pub struct AddArgs {
    pub ui: Option<String>,
    pub path: Option<String>,
    pub no_integrate: bool,
}
Expand description

Arguments for the dampen add command.

§Examples

# Add a window in default location (src/ui/)
dampen add --ui settings

# Add a window in custom location
dampen add --ui admin_panel --path "src/ui/admin"

§Fields

  • ui: Window name (converted to snake_case for filenames)
  • path: Custom output directory (relative to project root)

Fields§

§ui: Option<String>

Add a new UI window

The window name will be converted to snake_case for filenames.

Examples: settings → settings.rs, settings.dampen UserProfile → user_profile.rs, user_profile.dampen admin-panel → admin_panel.rs, admin_panel.dampen

§path: Option<String>

Custom output directory path (relative to project root)

If not provided, defaults to “src/ui/”

Examples: –path “src/ui/admin” → Files in src/ui/admin/ –path “ui/orders” → Files in ui/orders/

Security:

  • Must be relative (absolute paths rejected)
  • Must be within project (cannot escape via ..)
§no_integrate: bool

Disable automatic integration (do not update mod.rs)

By default, the command automatically adds pub mod <window_name>; to the appropriate mod.rs file. Use this flag to disable automatic integration and handle module registration manually.

Example: dampen add –ui settings –no-integrate

Trait Implementations§

Source§

impl Args for AddArgs

Source§

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments
Source§

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

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

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

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut Read more
Source§

impl Debug for AddArgs

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromArgMatches for AddArgs

Source§

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

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

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

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

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

Assign values from ArgMatches to self.
Source§

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

Assign values from ArgMatches to self.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.