Struct Session 

pub struct Session { /* private fields */ }

An attached agent serving a mirror. Clones share it.

Implementations

impl Session

pub fn start( attached: Attached, options: SessionOptions, controller: Option<ControllerLink>, ) -> Result<Session, SessionError>

A session over attached: reads the display density for the scale, and uses controller, when given, for touches and frames.

pub fn start_selected( attached: Attached, options: SessionOptions, selection: Selection, ) -> Result<Session, SessionError>

A session over attached on the paths selection chose (see select_paths).

pub fn status(&self) -> Status

What the session reports: the agent, the active paths, the keyboard capability, the fallback warning and what failed since.

pub fn backend(&self) -> Backend

The backend a mirror::Mirror runs on. Taken once: the event stream has one reader.

Panics

When called a second time.

pub fn agent(&self) -> &AgentInfo

pub fn outcome(&self) -> &Outcome

Whether the agent was launched or reused.

pub fn scale(&self) -> f64

Physical pixels per device point.

pub fn uses_controller(&self) -> bool

Whether touches and frames go through the emulator’s controller.

pub fn last_read(&self) -> Option<ReadStats>

What the last tree read returned.

pub fn reads(&self) -> u64

Tree reads made so far.

pub fn frames_received(&self) -> u64

Frames received from the controller so far.

pub fn inputs(&self) -> (u64, u64)

Inputs sent so far: through the controller, and through the agent.

pub fn controller_error(&self) -> Option<String>

Why the controller stopped taking input, once it failed; input then goes through the agent.

pub fn frame_error(&self) -> Option<String>

The last failure of the controller’s frame stream, which the session subscribes to again.

pub fn screenshot(&self, params: ScreenshotParams) -> Result<Screenshot, Error>

A screenshot through the agent.

pub fn close_reason(&self) -> Option<DisconnectReason>

Why the connection to the agent closed, once it has.

pub fn stop(&self, timeout: Duration) -> Result<Stopped, DeployError>

Stops the agent: shutdown, then a kill by pid past timeout.

Trait Implementations

impl Clone for Session

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Session

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

Formats the value using the given formatter.