Enum icinga2_api::types::common::command::IcingaCommandArgumentDescription

pub enum IcingaCommandArgumentDescription {
    String(String),
    Function(IcingaFunction),
    FullDescription {
        description: Option<String>,
        value: Option<String>,
        key: Option<String>,
        skip_key: Option<bool>,
        repeat_key: Option<bool>,
        set_if: Option<IcingaArgumentCondition>,
        required: Option<bool>,
        order: Option<u64>,
        separator: Option<String>,
    },
}

the description of a single command argument

Variants

String(String)

a simple string with the argument(s)

Function(IcingaFunction)

an icinga function

FullDescription

Fields

description: Option<String>

the description of this argument

value: Option<String>

the default value for this argument

key: Option<String>

name of an argument to set

skip_key: Option<bool>

should the key be skipped

repeat_key: Option<bool>

should the key be repeated

set_if: Option<IcingaArgumentCondition>

condition when to set it

required: Option<bool>

is this argument required

order: Option<u64>

determines the order in which the arguments are used

separator: Option<String>

separator for multiple values

a full description with details

Trait Implementations

impl Clone for IcingaCommandArgumentDescription

fn clone(&self) -> IcingaCommandArgumentDescription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IcingaCommandArgumentDescription

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IcingaCommandArgumentDescription

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Hash for IcingaCommandArgumentDescription

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for IcingaCommandArgumentDescription

fn cmp(&self, other: &IcingaCommandArgumentDescription) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<IcingaCommandArgumentDescription> for IcingaCommandArgumentDescription

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<IcingaCommandArgumentDescription> for IcingaCommandArgumentDescription

fn partial_cmp(
    &self,
    other: &IcingaCommandArgumentDescription
) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for IcingaCommandArgumentDescription

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for IcingaCommandArgumentDescription

impl StructuralEq for IcingaCommandArgumentDescription

impl StructuralPartialEq for IcingaCommandArgumentDescription