Struct Handle 

pub struct Handle<S: Server> {
    sender: Sender<CommandRequest<S>>,
    discovery_limiter: DiscoveryLimiter,
}

Handle to a Server passed to Apps.

Used to issue commands to the server. Since discovery is requested a often a separate struct is used to deal with discovery requests.

Fields

sender: Sender<CommandRequest<S>>

To send commands to the server

discovery_limiter: DiscoveryLimiter

To coordinate the handling of discovery requests

Implementations

impl<S: Server> Handle<S>

pub(crate) async fn issue_command(&self, command: Command<S>) -> Result<(), ()>

Issues command to Runner. Waits for the command to be next in line, but does not wait for the command to be completed.

May return Err(()) when another command shutdown the server before this command could be executed.

When Ok(()) is returned, this means the command is guaranteed to be executed momentarily.

pub async fn modify( &self, display: impl Display + Send + 'static, modifier: impl FnOnce(&mut S) -> bool + Send + 'static, ) -> Result<(), ()>

pub async fn inspect<T: Send + 'static>( &self, display: impl Display + Send + 'static, inspector: impl FnOnce(&S) -> T + Send + 'static, ) -> Result<T, ()>

Executes inspector on the server instance, returning its result.

Returns Err(()) when the command or its result could not be sent, probably because the server was shutting down.

pub async fn request_discovery( &self, app: Rc<S::AppT>, ) -> Result<DiscoveryRunResp>

Trait Implementations

impl<S: Server> Clone for Handle<S>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.