Skip to main content

Command

Struct Command 

Source
pub struct Command {
    pub requester: ProductOSRequestClient,
    pub node_url: Uri,
    pub verify_key: Vec<u8>,
    pub module: String,
    pub instruction: String,
    pub data: Option<Value>,
}
Expand description

Command structure for executing commands on remote nodes.

This struct holds all the necessary information to execute a command on a remote Product OS node, including authentication and target details.

§Examples

let command = Command {
    requester: ProductOSRequestClient::new(),
    node_url: Uri::from_str("https://localhost:8443").unwrap(),
    verify_key: vec![1, 2, 3, 4],
    module: "status".to_string(),
    instruction: "ping".to_string(),
    data: None,
};

Fields§

§requester: ProductOSRequestClient

HTTP client for making requests

§node_url: Uri

Target node URL

§verify_key: Vec<u8>

Verification key for authentication

§module: String

Module name to execute

§instruction: String

Instruction/command name

§data: Option<Value>

Optional data payload

Implementations§

Source§

impl Command

Source

pub async fn command( &self, ) -> Result<ProductOSResponse<BodyBytes>, ProductOSRequestError>

Execute this command on the target node.

Sends the command to the remote node and returns the response.

§Errors

Returns an error if the request fails or the node cannot be reached.

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> CastSlice<'_, T> for T

Source§

fn cast_slice(selves: &[T]) -> &[T]

Source§

impl<T> CastSliceMut<'_, T> for T

Source§

fn cast_slice_mut(selves: &mut [T]) -> &mut [T]

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more