Skip to main content

FloatingSurfaceClientMessage

Enum FloatingSurfaceClientMessage 

pub enum FloatingSurfaceClientMessage {
Show 19 variants ActionMarkers { markers: Vec<PaintedActionMarker>, }, MoveDeviceDisplay { request: u64, placement: DeviceDisplayMove, }, DeviceShellOutcome { request: u64, result: Result<Value, String>, }, AllowHostShell, OpenCaptureStudio { mode: CaptureStudioProtocolMode, }, Present { request: FloatingSurfaceProtocolRequest, }, UpdateRegion { id: String, region: [f64; 4], }, SurfaceGeometry { id: String, rect: [f64; 4], content_rect: [f64; 4], input_rect: Option<[f64; 4]>, }, SourceCleared { id: String, }, DestinationPresented { id: String, }, Suspend { id: String, rect: [f64; 4], content_rect: [f64; 4], }, Dismiss { id: String, }, SetCaptureProtection { protected: bool, generation: Option<u64>, }, PaintStream { payload: String, page: [f64; 4], scale: f64, }, PaintCapable, OpenTabBeside { target: Option<String>, background: bool, instance: Option<u64>, }, CloseTab { instance: Option<u64>, }, ReopenClosedTab, PlaceNextWindowBeside { background: bool, instance: Option<u64>, },
}
Expand description

App → shell lifecycle. Suspend is the reversible half of an attached ↔ desktop handoff: the authenticated native surface and its renderer stay warm while its pixels return to the app. Dismiss is deliberately permanent and reserved for hang-up, navigation-end, or an explicit close.

Variants§

§

ActionMarkers

Complete primary-surface marker inventory from a successfully presented SDK frame. The host resolves surface and room from launch custody.

Fields

§

MoveDeviceDisplay

A typed Settings request on the existing authenticated app connection.

Fields

§request: u64
§placement: DeviceDisplayMove
§

DeviceShellOutcome

Bounded response to a trusted owner operation on this same connection.

Fields

§request: u64
§

AllowHostShell

Terminal asks for the existing host-shell permission prompt.

§

OpenCaptureStudio

Ask the trusted session shell to show its ordinary user-confirmed chooser. This shares the same authenticated channel as floating surfaces so a separately hosted app and an embedded app have identical PiP UX.

§

Present

§

UpdateRegion

Fields

§region: [f64; 4]
§

SurfaceGeometry

Live desktop placement of an app-owned secondary surface. The shell clamps it to the combined output before presentation.

Fields

§rect: [f64; 4]

Full native-window bounds.

§content_rect: [f64; 4]

Shared placement/hit geometry inside that transparent window.

§input_rect: Option<[f64; 4]>

Interactive frame excluding shadow; absent means legacy window input.

§

SourceCleared

The primary window has presented a frame with the transferred pixels removed. The shell may now move its proxy/native surface away from the source rect without ever exposing two copies.

Fields

§

DestinationPresented

The primary app window has presented the first frame containing the reattached surface. Until this arrives, the compositor keeps a frozen copy of the last desktop-owned pixels in exactly the same place, so hiding the native secondary can never expose a blank transfer frame.

Fields

§

Suspend

Fields

§rect: [f64; 4]
§content_rect: [f64; 4]
§

Dismiss

Fields

§

SetCaptureProtection

Withhold every window of this app from captures — screenshots, recordings, screen sharing, remote viewers — or stop doing so. The local display is unaffected. The shell applies it to windows mapped later too, and drops it when this connection closes.

Fields

§protected: bool
§generation: Option<u64>
§

PaintStream

One frame of the page this app’s window shows, as a paint stream (tilo_paint_stream::wire::Payload, base64): the session shares it with web members as a display list they draw, instead of as video. page is where the page sits in the window, in logical pixels, and scale the window’s buffer scale, so the session can place input. Sent only while the shell has asked for it (FloatingSurfaceHostMessage::PaintKeyframe).

Fields

§payload: String
§page: [f64; 4]
§scale: f64
§

PaintCapable

This app can stream its window’s page (sent once): the shell may ask it to with FloatingSurfaceHostMessage::PaintKeyframe.

§

OpenTabBeside

Open another instance of this app as a desktop tab right after this app’s own tab (see crate::shell_tabs). target is a URI the app’s manifest declares, or None for an empty instance. instance is the record instance the shell launched this process for; the shell only uses it to find a tab that already shows this same app.

Fields

§target: Option<String>
§background: bool
§instance: Option<u64>
§

CloseTab

Close this app’s own tab through the desktop’s tab lifecycle.

Fields

§instance: Option<u64>
§

ReopenClosedTab

Reopen the workspace’s most recently closed tab.

§

PlaceNextWindowBeside

The next window this app maps lands as a tab right after this one.

Fields

§background: bool
§instance: Option<u64>

Trait Implementations§

§

impl Clone for FloatingSurfaceClientMessage

§

fn clone(&self) -> FloatingSurfaceClientMessage

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
§

impl Debug for FloatingSurfaceClientMessage

§

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

Formats the value using the given formatter. Read more
§

impl<'de> Deserialize<'de> for FloatingSurfaceClientMessage

§

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

Deserialize this value from the given Serde deserializer. Read more
§

impl PartialEq for FloatingSurfaceClientMessage

§

fn eq(&self, other: &FloatingSurfaceClientMessage) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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 FloatingSurfaceClientMessage

§

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. Read more
§

impl StructuralPartialEq for FloatingSurfaceClientMessage

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
§

impl<T> AnyEq for T
where T: Any + PartialEq,

§

fn equals(&self, other: &(dyn Any + 'static)) -> bool

§

fn as_any(&self) -> &(dyn Any + 'static)

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

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

§

fn simd_from(_simd: S, value: T) -> T

§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

§

fn simd_into(self, simd: S) -> T

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> Fruit for T
where T: Send + Downcast,

§

impl<T> MaybeSendSync for T
where T: Send + Sync + ?Sized,

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T

§

impl<T> WasmNotSync for T
where T: Sync,