Struct Command 

#[non_exhaustive]
pub struct Command<V> {
    pub action: Action,
    pub target: Target<V>,
    pub args: Args<V>,
    pub profile: Option<Nsid>,
    pub command_id: Option<CommandId>,
}

An OpenC2 command communicates an action to be performed on a target.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

action: Action

The task or activity to be performed.

target: Target<V>

The object of the action. The action is performed on the target.

args: Args<V>

profile: Option<Nsid>

The object which will perform the action on the target.

command_id: Option<CommandId>

Implementations

impl<V> Command<V>

pub fn new(action: Action, target: impl Into<Target<V>>) -> Self

Create a new command without an actuator.

pub fn with_args(self, args: Args<V>) -> Self

pub fn with_profile(self, profile: impl Into<Nsid>) -> Self

pub fn with_command_id(self, command_id: impl Into<CommandId>) -> Self

pub fn as_action_target(&self) -> (Action, &Target<V>)

Returns the action and target of the command as a tuple.

Usage

fn example<V>(cmd: &Command<V>) -> Result<(), Error> {
    match cmd.as_action_target() {
      (Action::Query, Target::Features(features)) => {
          // handle feature query
         Ok(())
      }
     (action, target) => Err(Error::not_implemented_pair(action, &target.into())),
  }
}

Trait Implementations

impl<'a, V: Serialize> AsContent for &'a Command<V>

type Output = CommandAsContent<'a, V>

The intermediate type that represents Self in a way that complies with the OpenC2 content structure.

fn as_content(&self) -> Self::Output

impl<V: Clone> Clone for Command<V>

fn clone(&self) -> Command<V>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V: Debug> Debug for Command<V>

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

Formats the value using the given formatter.

impl<'de, V> Deserialize<'de> for Command<V>

where V: Deserialize<'de> + Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<V> From<Command<V>> for Content<V>

Convert into Request variant.

fn from(v: Command<V>) -> Self

Converts to this type from the input type.

impl<H: Default, V> From<Command<V>> for Message<H, Command<V>>

fn from(value: Command<V>) -> Self

Converts to this type from the input type.

impl<V> Serialize for Command<V>

where V: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<V> TryFrom<Body<Content<V>>> for Command<V>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Body<Content<V>>) -> Result<Self, Self::Error>

Performs the conversion.