Struct RunCommand

pub struct RunCommand<TParameter, TResponse> { /* private fields */ }

The RunCommand is a query request that will run a named command with a parameter, returning the result as a stream of responses to a target

Implementations

impl<TParameter, TResponse> RunCommand<TParameter, TResponse>

where TParameter: Unpin + Send, TResponse: Unpin + Send,

pub fn new( target: impl Into<StreamTarget>, name: impl Into<String>, parameter: impl Into<TParameter>, ) -> Self

Creates a new ‘run command’ request. The command with the specified name will be run, and will send its response to the target.

pub fn target(&self) -> StreamTarget

Returns the program that the response to the command should be setn to

pub fn name(&self) -> &str

The name of the command that is to be run

pub fn parameter(&self) -> &TParameter

The parameter to the command

Trait Implementations

impl<TParameter: Clone, TResponse: Clone> Clone for RunCommand<TParameter, TResponse>

fn clone(&self) -> RunCommand<TParameter, TResponse>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TParameter: Debug, TResponse: Debug> Debug for RunCommand<TParameter, TResponse>

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

Formats the value using the given formatter.

impl<'de, TParameter, TResponse> Deserialize<'de> for RunCommand<TParameter, TResponse>

where TParameter: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<TParameter: PartialEq, TResponse: PartialEq> PartialEq for RunCommand<TParameter, TResponse>

fn eq(&self, other: &RunCommand<TParameter, TResponse>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<TParameter, TResponse> QueryRequest for RunCommand<TParameter, TResponse>

where for<'de> TParameter: 'static + Unpin + Send + Serialize + Deserialize<'de>, for<'de> TResponse: 'static + Unpin + Send + Serialize + Deserialize<'de>,

type ResponseData = TResponse

An object receiving this query request will send back a QueryResponse<Self::ResponseData>

fn with_new_target(self, new_target: StreamTarget) -> Self

Updates this request to use a different target

impl<TParameter, TResponse> SceneMessage for RunCommand<TParameter, TResponse>

where for<'de> TParameter: 'static + Unpin + Send + Serialize + Deserialize<'de>, for<'de> TResponse: 'static + Unpin + Send + Serialize + Deserialize<'de>,

fn message_type_name() -> String

A string that identifies this message type uniquely when serializing

fn default_target() -> StreamTarget

The default target for this message type

fn initialise(init_context: &impl SceneInitialisationContext)

Sets up this message type in a scene. This can be an opportunity to set up default filters and connections for a particular message type. This is called the first time that a message is referenced in a scene.

fn allow_thread_stealing_by_default() -> bool

True if input streams for this message type should allow thread stealing by default

fn serializable() -> bool

True if this message supports serialization

impl<TParameter, TResponse> Serialize for RunCommand<TParameter, TResponse>

where TParameter: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<TParameter: Eq, TResponse: Eq> Eq for RunCommand<TParameter, TResponse>

impl<TParameter, TResponse> StructuralPartialEq for RunCommand<TParameter, TResponse>