Skip to main content

Message

coralstack_cmd_ipc::message

Enum Message

pub enum Message {
    RegisterCommandRequest {
        id: MessageId,
        meta: Option<MessageMeta>,
        command: CommandDef,
    },
    RegisterCommandResponse {
        id: MessageId,
        meta: Option<MessageMeta>,
        thid: MessageId,
        response: RegisterResult,
    },
    ListCommandsRequest {
        id: MessageId,
        meta: Option<MessageMeta>,
    },
    ListCommandsResponse {
        id: MessageId,
        meta: Option<MessageMeta>,
        thid: MessageId,
        commands: Vec<CommandDef>,
    },
    ExecuteCommandRequest {
        id: MessageId,
        meta: Option<MessageMeta>,
        command_id: String,
        request: Option<Value>,
    },
    ExecuteCommandResponse {
        id: MessageId,
        meta: Option<MessageMeta>,
        thid: MessageId,
        response: ExecuteResult,
    },
    Event {
        id: MessageId,
        meta: Option<MessageMeta>,
        event_id: String,
        payload: Option<Value>,
    },
}

Expand description

Discriminated union of every message type carried on a channel.

The type tag strings are the same dotted identifiers used by the TypeScript MessageType enum.

Variants§

RegisterCommandRequest

Fields

§id: MessageId

§meta: Option<MessageMeta>

§command: CommandDef

RegisterCommandResponse

Fields

§id: MessageId

§meta: Option<MessageMeta>

§thid: MessageId

§response: RegisterResult

ListCommandsRequest

Fields

§id: MessageId

§meta: Option<MessageMeta>

ListCommandsResponse

Fields

§id: MessageId

§meta: Option<MessageMeta>

§thid: MessageId

§commands: Vec<CommandDef>

ExecuteCommandRequest

Fields

§id: MessageId

§meta: Option<MessageMeta>

§command_id: String

§request: Option<Value>

ExecuteCommandResponse

Fields

§id: MessageId

§meta: Option<MessageMeta>

§thid: MessageId

§response: ExecuteResult

Event

Fields

§id: MessageId

§meta: Option<MessageMeta>

§event_id: String

§payload: Option<Value>

Implementations§

impl Message

pub fn id(&self) -> MessageId

Returns the message’s id field.

pub fn thid(&self) -> Option<MessageId>

Returns the thid field for messages that carry one.

pub fn meta(&self) -> Option<&MessageMeta>

Returns the optional transport-level _meta envelope.

Trait Implementations§

impl Clone for Message

fn clone(&self) -> Message

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

impl Debug for Message

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for Message

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

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq for Message

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

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

1.0.0 (const: unstable) · 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.

impl Serialize for Message

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

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for Message

Auto Trait Implementations§

impl Freeze for Message

impl RefUnwindSafe for Message

impl Send for Message

impl Sync for Message

impl Unpin for Message

impl UnsafeUnpin for Message

impl UnwindSafe for Message

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

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

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

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

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