Enum RemoteActionMessage 

pub enum RemoteActionMessage {
    FeedbackRequest {
        correlation: u64,
        query: FeedbackQuery,
    },
    FeedbackResponse {
        correlation: u64,
        result: Result<FeedbackAnswer, ActionHostError>,
    },
    CatalogueRequest {
        correlation: u64,
        query: CatalogueQuery,
    },
    CatalogueResponse {
        correlation: u64,
        result: Result<CataloguePage, ActionHostError>,
    },
    Invoke(InvokeRequest),
    Receipt(InvocationReceipt),
    Observe {
        invocation: InvocationId,
        wait_ms: Option<u32>,
        seen: Option<UpdateMark>,
    },
    Update {
        invocation: InvocationId,
        state: Option<InvocationState>,
    },
    Cancel {
        invocation: InvocationId,
    },
    CancelResponse {
        invocation: InvocationId,
        result: Result<(), ActionHostError>,
    },
    RecordRequest {
        correlation: u64,
        query: RecordQuery,
    },
    RecordResponse {
        correlation: u64,
        result: Result<RecordPiece, ActionHostError>,
    },
}

Everything that crosses the wire for remote action use.

Variants

FeedbackRequest

Inspect existing feedback admission or read an existing canonical ack. This never invokes a document mutation or grants room access.

Fields

correlation: u64

query: FeedbackQuery

FeedbackResponse

Fields

correlation: u64

result: Result<FeedbackAnswer, ActionHostError>

CatalogueRequest

Ask for one page of the actions offered to the caller.

Fields

correlation: u64

query: CatalogueQuery

CatalogueResponse

Answer to a Self::CatalogueRequest with the same correlation.

Fields

correlation: u64

result: Result<CataloguePage, ActionHostError>

Invoke(InvokeRequest)

Run one action.

Receipt(InvocationReceipt)

Answer to Self::Invoke; a refusal is ReceiptStatus::Rejected.

Observe

Ask for an invocation’s latest state.

Fields

invocation: InvocationId

wait_ms: Option<u32>

Hold the answer until the invocation moves past seen (or, with no seen, settles) or this many milliseconds pass, at most MAX_REMOTE_WAIT; then answer with the state as it is. A host that predates it answers at once, as before.

seen: Option<UpdateMark>

How far the caller has already seen the invocation get.

Update

Answer to Self::Observe; None for an id the caller does not own. A host may also push this unprompted as an invocation progresses.

Fields

invocation: InvocationId

state: Option<InvocationState>

Cancel

Ask a running invocation to stop.

Fields

invocation: InvocationId

CancelResponse

Answer to Self::Cancel.

Fields

invocation: InvocationId

result: Result<(), ActionHostError>

RecordRequest

Ask a device for a room record it holds, from query.offset on. The same authenticated device-to-device route as an action, but answered by the device from what its app last made durable, not by an action host: a record is readable where it is kept whether or not its app is running.

Fields

correlation: u64

query: RecordQuery

RecordResponse

Answer to Self::RecordRequest with the same correlation: the next piece of the record, or why it is not given.

Fields

correlation: u64

result: Result<RecordPiece, ActionHostError>

Implementations

impl RemoteActionMessage

pub const fn observe(invocation: InvocationId) -> RemoteActionMessage

Ask for invocation’s state as it is now.

pub const fn waits(&self) -> bool

Whether this request asks its host to hold the answer until the invocation moves, so whatever carries it must not wait behind it.

pub const fn is_request(&self) -> bool

Whether a host answers this message (as opposed to a caller receiving it).

Trait Implementations

impl Clone for RemoteActionMessage

fn clone(&self) -> RemoteActionMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RemoteActionMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RemoteActionMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RemoteActionMessage

fn eq(&self, other: &RemoteActionMessage) -> 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 Serialize for RemoteActionMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RemoteActionMessage