Skip to main content

FloatingSurfaceHostMessage

Enum FloatingSurfaceHostMessage 

pub enum FloatingSurfaceHostMessage {
Show 13 variants DeviceDisplayMoveResult { request: u64, result: Result<(), String>, }, DeviceShellOperation { request: u64, operation: DeviceShellOperation, }, CaptureProtectionApplied { generation: u64, protected: bool, }, HostShellAllowed { allowed: bool, }, DesktopBounds { bounds: [f64; 4], }, PaintKeyframe, PaintStop, PrepareSurface { id: String, token: String, rect: [f64; 4], content_rect: [f64; 4], transfer_covered: bool, coordinate_offset: [f64; 2], }, Adopted { id: String, rect: [f64; 4], }, Suspended { id: String, }, Reattach { id: String, }, Closed { id: String, }, Appearance { theme: Option<ThemeDocument>, network_status: Option<HostNetworkStatus>, workspace_hue: Option<f32>, your_colour: Option<String>, },
}
Expand description

Shell → app lifecycle. The shell supplies one authoritative combined desktop coordinate space and explicitly acknowledges ownership changes; transports must not infer either from timing.

Variants§

§

DeviceDisplayMoveResult

Admission/delivery result. The owner’s published topology confirms application.

Fields

§request: u64
§result: Result<(), String>
§

DeviceShellOperation

The authenticated device owner selected Terminal’s device-shell target. This requests its ordinary permission flow; it is not a grant.

Fields

§request: u64
§

CaptureProtectionApplied

Sent only after the compositor has installed the requested policy.

Fields

§generation: u64
§protected: bool
§

HostShellAllowed

The trusted desktop’s answer, after supervisor admission.

Fields

§allowed: bool
§

DesktopBounds

Fields

§bounds: [f64; 4]
§

PaintKeyframe

Someone started watching this app’s window: send its page as a paint stream, starting from a whole frame.

§

PaintStop

Nobody watches the window any more: stop capturing the page.

§

PrepareSurface

Authorises creation of one secondary toplevel. token is random and scoped to this authenticated connection; merely copying an app id can never gain overlay authority.

Fields

§token: String
§rect: [f64; 4]
§content_rect: [f64; 4]
§transfer_covered: bool

True when the shell has already installed a frozen, pixel-exact transfer frame for this surface. The app can hide its in-window copy immediately in that case; if capture failed it keeps drawing until the native surface acknowledges its first buffer.

§coordinate_offset: [f64; 2]

App-local → desktop pointer-coordinate translation. Kept separate from clamped window geometry so a live drag can rebase without treating compositor clamping as pointer motion.

§

Adopted

Fields

§rect: [f64; 4]
§

Suspended

The shell has hidden, but retained, the authenticated native surface. A later Present for the same connection/id resumes that exact surface instead of issuing a new capability or renderer.

Fields

§

Reattach

Fields

§

Closed

Fields

§

Appearance

Where and for whom the app’s window is shown (crate::theme::WindowAppearance): the temperature of the workspace holding it and the person’s colour. Sent when the app connects and again whenever either changes — a workspace switch, a new wallpaper, a window moved to another workspace, a colour chosen in Settings.

Fields

§theme: Option<ThemeDocument>

The host’s configured palette; apps cannot read its settings file through their private sandbox configuration directory.

§network_status: Option<HostNetworkStatus>

Absent on older hosts or launches without network access.

§workspace_hue: Option<f32>

OKLCH degrees; absent while the workspace has no temperature.

§your_colour: Option<String>

A presence hue by its stored name (PresenceHue::id).

Implementations§

§

impl FloatingSurfaceHostMessage

pub fn appearance(appearance: &WindowAppearance) -> FloatingSurfaceHostMessage

The message that tells a window appearance.

pub fn appearance_with_theme( appearance: &WindowAppearance, theme: &Theme, ) -> FloatingSurfaceHostMessage

The host’s configured theme and the window’s workspace appearance.

pub fn configured_theme(&self) -> Option<Theme>

Validate the host’s authored palette before applying it.

pub fn window_appearance(&self) -> Option<WindowAppearance>

What an Self::Appearance message says, None for any other. A colour this build does not name, or a hue that is not a number, counts as unsaid.

Trait Implementations§

§

impl Clone for FloatingSurfaceHostMessage

§

fn clone(&self) -> FloatingSurfaceHostMessage

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 FloatingSurfaceHostMessage

§

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

Formats the value using the given formatter. Read more
§

impl<'de> Deserialize<'de> for FloatingSurfaceHostMessage

§

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

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

impl PartialEq for FloatingSurfaceHostMessage

§

fn eq(&self, other: &FloatingSurfaceHostMessage) -> 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 FloatingSurfaceHostMessage

§

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 FloatingSurfaceHostMessage

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,