Struct ModuleSpec 

pub struct ModuleSpec {
    pub name: &'static str,
    pub free_form: bool,
    pub summary: &'static str,
    pub args: &'static [ModuleArg],
    pub validated_as: Option<&'static str>,
}

One native module: its Ansible name and how the controller parses its arguments.

Fields

name: &'static str

Short name, without the ansible.builtin. prefix.

free_form: bool

The task’s string form is a command line kept whole as _raw_params, instead of key=value pairs.

summary: &'static str

One line for the generated documentation.

args: &'static [ModuleArg]

Every argument the reference accepts for this module, sorted, with what this release does with each. Empty for a module whose arguments nothing here checks yet.

validated_as: Option<&'static str>

The name the reference validates this module’s arguments under, when it validates them at all, and so the name its refusal carries.

Measured on ansible-core 2.19.12: shell is executed by the command module, so an argument neither module has is refused as ansible.legacy.command under both names and against one list. raw never reaches a module at all - its action plugin hands the line to the shell - so it takes any argument without looking at it, and a run that refused one would refuse a playbook the reference runs.

Trait Implementations

impl Clone for ModuleSpec

fn clone(&self) -> ModuleSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ModuleSpec

impl Debug for ModuleSpec

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

Formats the value using the given formatter.

impl Eq for ModuleSpec

impl PartialEq for ModuleSpec

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ModuleSpec