Skip to main content

CommandEnvelope

Struct CommandEnvelope 

Source
pub struct CommandEnvelope { /* private fields */ }
Expand description

A versioned command transport envelope.

Implementations§

Source§

impl CommandEnvelope

Source

pub fn new( command_id: CommandId, session_id: Option<SessionId>, timestamp: ProtocolTimestamp, command: AgentCommand, ) -> Result<Self, CommandValidationError>

Creates a validated current-version command envelope.

§Errors

Returns an error when session presence or command payload invariants fail.

Source

pub fn decode_value(value: Value) -> Result<Self, CommandDecodeError>

Decodes a JSON value while preserving unsupported-command classification.

§Errors

Returns CommandDecodeError::UnsupportedType for an unknown safe discriminator and CommandDecodeError::Invalid for malformed input.

Source

pub const fn protocol_version(&self) -> ProtocolVersion

Returns the protocol version read from or written to the envelope.

Source

pub const fn command_id(&self) -> CommandId

Returns the command identifier.

Source

pub const fn session_id(&self) -> Option<SessionId>

Returns the target session, absent only for session creation.

Source

pub const fn timestamp(&self) -> ProtocolTimestamp

Returns the command timestamp.

Source

pub const fn command(&self) -> &AgentCommand

Returns the command payload.

Source

pub const fn command_type(&self) -> AgentCommandType

Returns the stable command discriminator.

Trait Implementations§

Source§

impl Clone for CommandEnvelope

Source§

fn clone(&self) -> CommandEnvelope

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CommandEnvelope

Source§

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

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

impl<'de> Deserialize<'de> for CommandEnvelope

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 PartialEq for CommandEnvelope

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for CommandEnvelope

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 StructuralPartialEq for CommandEnvelope

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> 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.