Skip to main content

MachineRoom

Struct MachineRoom 

Source
pub struct MachineRoom { /* private fields */ }

Implementations§

Source§

impl MachineRoom

Source

pub fn machine(&self) -> u64

The machine id, the number connect takes.

Source

pub fn repository(&self) -> u64

Source

pub fn windows(&self) -> HashMap<u64, Window>

Source

pub fn files(&self) -> HashMap<u64, FilesState>

Each Files window’s folder and view, by window id.

Source

pub fn status(&self) -> MachineStatus

Source

pub fn error(&self) -> String

Why the machine failed, when it did.

Source

pub fn name(&self) -> String

The repository’s name, so a guest who joined by code knows what it is.

Source

pub fn private(&self) -> bool

Its connections go out only from a residential address, billed per GB to whoever pays for the machine. Stays true while private is paused.

Source

pub fn private_reason(&self) -> String

Why private is paused while it reconnects, like a payer out of balance. Its internet is cut until then. Empty while private carries traffic, or is off.

Source

pub fn hydrate(&self, state: &Value)

Apply a connection snapshot { machine, bootstrap, cursor, windows }.

Source

pub fn watch(&self, hooks: Arc<dyn MachineRoomHooks>)

Source

pub async fn invoke_tool(&self, tool: &MachineTool) -> Result<String>

Source

pub async fn exec(&self, command: &str, opts: ExecOptions) -> Result<ExecResult>

Run a shell command as agent in /repository with DISPLAY=:0, so GUI apps open as desktop windows.

Source

pub async fn set_viewport(&self, width: f64, height: f64) -> Result<()>

Size the machine’s desktop to this seat’s screen, clamped to VIEWPORT. Only the controller can.

Source

pub async fn open(&self, path: &str) -> Result<()>

Open a file in an app on the machine, for everyone to see: text in nano inside an xterm, anything else with an installed opener. Only the controller can.

Source

pub async fn set_files(&self, window: u64, files: &FilesState) -> Result<()>

Put a Files window on a folder and view for every seat. Only the controller can.

Source

pub async fn stop(&self) -> Result<()>

Save a new revision and shut down. The room closes afterwards.

Source

pub fn parrot_tools(&self) -> Vec<Tool>

Source

pub fn handle_event(&self, packet: &Value) -> bool

Source

pub async fn start( authorization: &CredentialsOrApiKey, repository: u64, opts: StartOptions, ) -> Result<(MachineRoom, Presence)>

Boot the repository’s machine, or return the one already live, and connect to it. private sends its connections out from a residential address, billed per GB to whoever pays for the machine; on a live machine it switches it.

Source

pub async fn shutdown( authorization: &CredentialsOrApiKey, repository: u64, opts: GroupOptions, ) -> Result<()>

Save and shut down a repository’s machine without joining its room. For its owner or group members.

Source

pub async fn set_private( authorization: &CredentialsOrApiKey, repository: u64, on: bool, opts: GroupOptions, ) -> Result<PrivateState>

Turn private on or off for a repository’s live machine, for its owner or group members. Resolves to the machine’s private state and, while it’s paused, why.

Source

pub async fn connect( authorization: &CredentialsOrApiKey, target: &MachineTarget, opts: MachineOptions, ) -> Result<(MachineRoom, Presence)>

Connect to a live machine by id, or by its termite:machine:{id} reference.

Source

pub async fn join( authorization: &CredentialsOrApiKey, access_code: &str, opts: MachineOptions, ) -> Result<(MachineRoom, Presence)>

Join a machine someone shared with an access code.

Methods from Deref<Target = PageRoom>§

Source

pub fn web(&self) -> &WebRoom

Source

pub fn cursor(&self) -> HtmlPointer

Source

pub fn enabled_tools(&self) -> &HashSet<String>

Source

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

The seat (presence id) whose actions run.

Source

pub fn agent(&self) -> Option<RoomAgent>

Set while a server agent holds the room.

Source

pub fn watch(&self, hooks: Arc<dyn BrowserRoomHooks>)

Source

pub fn controlling(&self, me: &Presence) -> bool

Whether your actions run: you control it and no agent holds it.

Source

pub async fn set_controller(&self, seat: Option<&str>) -> Result<()>

Hand control to a seat, or take it yourself without one. While an agent holds the room this stops the agent.

Source

pub fn emit_presence(&self)

Presence changed: tell whoever is watching now.

Source

pub fn emit_closed(&self)

Source

pub async fn invoke_tool(&self, tool: &BrowserTool) -> Result<String>

Source

pub fn parrot_tools(&self) -> Vec<Tool>

Source

pub fn handle_event(&self, packet: &Value) -> bool

Methods from Deref<Target = Room>§

Source

pub fn endpoint(&self) -> &str

Source

pub fn ws(&self) -> RoomSocket

Source

pub fn authorization(&self) -> &Authorization

Source

pub fn id(&self) -> &str

Source

pub fn get_presences(&self) -> Vec<Presence>

Source

pub fn get_authorization(&self) -> &CredentialsOrApiKey

The caller’s Credentials or ApiKey from the live authorization pack.

Source

pub fn post(&self, packet: &Value)

Source

pub fn disconnect(&self)

Source

pub async fn generate_access_code(&self) -> Result<String>

Trait Implementations§

Source§

impl Clone for MachineRoom

Source§

fn clone(&self) -> Self

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
Source§

impl Deref for MachineRoom

Source§

type Target = PageRoom

The resulting type after dereferencing.
Source§

fn deref(&self) -> &PageRoom

Dereferences the value.

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more