NumCommands

pub struct NumCommands {
    pub id: Uuid,
    pub args: Vec<Value>,
    pub cmd_ignore: Value,
    pub cmd_result: Value,
    pub command: String,
    pub help: String,
    pub namespace: String,
    pub extensions: Extensions,
}
Expand description

§EntityType NumCommands

§Fully Qualified Namespace

reactive_graph::command::NumCommands

§Description

The number of commands

§Components

ComponentDescriptionProperties
reactive_graph::command::CommandA command which can be executed. The command has a name and can have command arguments.
  • args
  • cmd_ignore
  • cmd_result
  • command
  • help
  • namespace

§Properties from components

  • args
  • cmd_ignore
  • cmd_result
  • command
  • help
  • namespace

§JSON Schema

https://schema.reactive-graph.io/schema/json/dynamic_graph/types/entity/reactive_graph/command/NumCommands.schema.json

Fields§

§id: Uuid§args: Vec<Value>
§Property args

The command arguments

Data Type: Array

Socket Type: None

Mutability: Immutable

§cmd_ignore: Value
§Property cmd_ignore

blah

Data Type: Any

Socket Type: None

Mutability: Mutable

§cmd_result: Value
§Property cmd_result

The result of the command

Data Type: Any

Socket Type: Output

Mutability: Immutable

§command: String
§Property command

The command name

Data Type: String

Socket Type: None

Mutability: Immutable

§help: String
§Property help

Help text which explains the command.

Data Type: String

Socket Type: None

Mutability: Immutable

§namespace: String
§Property namespace

The command namespace

Data Type: String

Socket Type: None

Mutability: Immutable

§extensions: Extensions

Implementations§

Source§

impl NumCommands

Source

pub fn builder() -> NumCommandsBuilder<((), (), (), (), (), (), (), ())>

Create a builder for building NumCommands. On the builder, call .id(...)(optional), .args(...), .cmd_ignore(...), .cmd_result(...), .command(...), .help(...), .namespace(...), .extensions(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of NumCommands.

Source§

impl NumCommands

Source

pub fn new( args: Vec<Value>, cmd_ignore: Value, cmd_result: Value, command: String, help: String, namespace: String, ) -> Self

Source

pub fn new_with_id( id: Uuid, args: Vec<Value>, cmd_ignore: Value, cmd_result: Value, command: String, help: String, namespace: String, ) -> Self

Source

pub fn new_with_extensions( id: Uuid, args: Vec<Value>, cmd_ignore: Value, cmd_result: Value, command: String, help: String, namespace: String, extensions: Extensions, ) -> Self

Source

pub fn id(&self) -> Uuid

Source

pub fn args(&self) -> Vec<Value>

§Property args

The command arguments

Data Type: Array

Socket Type: None

Mutability: Immutable

Source

pub fn cmd_ignore(&self) -> Value

§Property cmd_ignore

blah

Data Type: Any

Socket Type: None

Mutability: Mutable

Source

pub fn set_cmd_ignore(&mut self, cmd_ignore: Value)

§Property cmd_ignore

blah

Data Type: Any

Socket Type: None

Mutability: Mutable

Source

pub fn cmd_result(&self) -> Value

§Property cmd_result

The result of the command

Data Type: Any

Socket Type: Output

Mutability: Immutable

Source

pub fn command(&self) -> String

§Property command

The command name

Data Type: String

Socket Type: None

Mutability: Immutable

Source

pub fn help(&self) -> String

§Property help

Help text which explains the command.

Data Type: String

Socket Type: None

Mutability: Immutable

Source

pub fn namespace(&self) -> String

§Property namespace

The command namespace

Data Type: String

Socket Type: None

Mutability: Immutable

Source

pub fn properties(&self) -> PropertyInstances

Source

pub fn extensions(&self) -> Extensions

Trait Implementations§

Source§

impl Clone for NumCommands

Source§

fn clone(&self) -> NumCommands

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Command for NumCommands

Source§

fn args(&self) -> Vec<Value>

§Property args

The command arguments

Data Type: Array

Socket Type: None

Mutability: Immutable

Source§

fn cmd_ignore(&self) -> Value

§Property cmd_ignore

blah

Data Type: Any

Socket Type: None

Mutability: Mutable

Source§

fn set_cmd_ignore(&mut self, cmd_ignore: Value)

§Property cmd_ignore

blah

Data Type: Any

Socket Type: None

Mutability: Mutable

Source§

fn cmd_result(&self) -> Value

§Property cmd_result

The result of the command

Data Type: Any

Socket Type: Output

Mutability: Immutable

Source§

fn command(&self) -> String

§Property command

The command name

Data Type: String

Socket Type: None

Mutability: Immutable

Source§

fn help(&self) -> String

§Property help

Help text which explains the command.

Data Type: String

Socket Type: None

Mutability: Immutable

Source§

fn namespace(&self) -> String

§Property namespace

The command namespace

Data Type: String

Socket Type: None

Mutability: Immutable

Source§

impl Debug for NumCommands

Source§

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

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

impl<'de> Deserialize<'de> for NumCommands

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<NumCommands> for EntityInstance

Source§

fn from(num_commands: NumCommands) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for NumCommands

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for NumCommands

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl TryFrom<EntityInstance> for NumCommands

Source§

type Error = ()

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

fn try_from(entity_instance: EntityInstance) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl Eq for NumCommands

Source§

impl StructuralPartialEq for NumCommands

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,