Struct RemoteActions 

pub struct RemoteActions { /* private fields */ }

An application’s client for the session’s action door. Clones share one client.

Implementations

impl RemoteActions

pub fn session() -> RemoteActions

A client that talks through the application’s collaboration connection. Until the root hands it to the host (see the module docs), its requests wait.

pub fn with_host( host: Arc<dyn ActionHost + Send + Sync>, caller: Caller, ) -> RemoteActions

A client served by host in this process, as caller.

pub fn current() -> RemoteActions

The client this thread’s app should use: one served by the host a RemoteActions::enter guard installed, else session.

pub fn enter( host: Arc<dyn ActionHost + Send + Sync>, caller: Caller, ) -> RemoteActionsGuard

Serve every client current makes on this thread from host, as caller, until the guard drops — how a test or an embedding host stands in for the session.

pub fn catalogue( &self, query: CatalogueQuery, ) -> LocalState<RemoteCall<CataloguePage>>

Read every page of query from the catalogue the app is offered.

pub fn catalogue_page( &self, query: CatalogueQuery, ) -> LocalState<RemoteCall<CataloguePage>>

Read exactly one bounded page of query.

This is for clients that traverse a resource hierarchy and therefore must own one global page/work budget across parents. The returned cursor is opaque and may only be sent back with the same provider, parent and revision.

pub fn invoke( &self, target: RemoteActionTarget, argument: InvokeArgument, confirmation: Option<Confirmation>, ) -> LocalState<RemoteCall<InvocationUpdate>>

Invoke the action at target with argument, carrying the person’s explicit confirmation when its contract asks for one.

pub fn invoke_with_id( &self, invocation: InvocationId, target: RemoteActionTarget, argument: InvokeArgument, confirmation: Option<Confirmation>, ) -> LocalState<RemoteCall<InvocationUpdate>>

Invoke an action with a caller-owned stable identity.

Use this when the durable object that caused the request already has a UUID. Reusing that UUID across reconnects lets the host deduplicate a retry after an acknowledgement is lost; it does not grant any authority.

pub fn is_busy(&self) -> bool

Whether any request is still waiting for its answer.

pub fn cancel( &self, invocation: InvocationId, ) -> Option<LocalState<CancellationCall>>

Ask the host to cancel an invocation this client is still observing. Repeated calls share one request and receipt. Acknowledged means only that the host accepted the cancellation request; the invocation’s own call is the authority for whether it actually stopped.

pub fn poll(&self)

Ask after invocations a host that does not wait is still running, once each is due. The host connection does this on every pump; call it directly only for a client served with_host.

Trait Implementations

impl Clone for RemoteActions

fn clone(&self) -> RemoteActions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Collaborative for RemoteActions

fn take_collab_requests(&mut self) -> Vec<CollabRequest>

Drain session-local requests for the authenticated collaboration host.

fn handle_collab_event(&mut self, event: &CollabEvent)

Receive one session-local broker event.

impl Debug for RemoteActions

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

Formats the value using the given formatter.

impl Default for RemoteActions

fn default() -> RemoteActions

Returns the “default value” for a type.