Struct ExtForeignToplevelHandleV1

pub struct ExtForeignToplevelHandleV1 { /* private fields */ }

Available on crate feature wayland and Linux only.

a mapped toplevel

A ext_foreign_toplevel_handle_v1 object represents a mapped toplevel window. A single app may have multiple mapped toplevels.

See also the Request enum for this interface.

Implementations

impl ExtForeignToplevelHandleV1

pub fn closed(&self)

the toplevel has been closed

The server will emit no further events on the ext_foreign_toplevel_handle_v1 after this event. Any requests received aside from the destroy request must be ignored. Upon receiving this event, the client should destroy the handle.

Other protocols which extend the ext_foreign_toplevel_handle_v1 interface must also ignore requests other than destructors.

pub fn done(&self)

all information about the toplevel has been sent

This event is sent after all changes in the toplevel state have been sent.

This allows changes to the ext_foreign_toplevel_handle_v1 properties to be atomically applied. Other protocols which extend the ext_foreign_toplevel_handle_v1 interface may use this event to also atomically apply any pending state.

This event must not be sent after the ext_foreign_toplevel_handle_v1.closed event.

pub fn title(&self, title: String)

title change

The title of the toplevel has changed.

The configured state must not be applied immediately. See ext_foreign_toplevel_handle_v1.done for details.

pub fn app_id(&self, app_id: String)

app_id change

The app id of the toplevel has changed.

The configured state must not be applied immediately. See ext_foreign_toplevel_handle_v1.done for details.

pub fn identifier(&self, identifier: String)

a stable identifier for a toplevel

This identifier is used to check if two or more toplevel handles belong to the same toplevel.

The identifier is useful for command line tools or privileged clients which may need to reference an exact toplevel across processes or instances of the ext_foreign_toplevel_list_v1 global.

The compositor must only send this event when the handle is created.

The identifier must be unique per toplevel and it’s handles. Two different toplevels must not have the same identifier. The identifier is only valid as long as the toplevel is mapped. If the toplevel is unmapped the identifier must not be reused. An identifier must not be reused by the compositor to ensure there are no races when sharing identifiers between processes.

An identifier is a string that contains up to 32 printable ASCII bytes. An identifier must not be an empty string. It is recommended that a compositor includes an opaque generation value in identifiers. How the generation value is used when generating the identifier is implementation dependent.

Trait Implementations

impl Borrow<ObjectId> for ExtForeignToplevelHandleV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for ExtForeignToplevelHandleV1

fn clone(&self) -> ExtForeignToplevelHandleV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExtForeignToplevelHandleV1

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

Formats the value using the given formatter.

impl Hash for ExtForeignToplevelHandleV1

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Weak<ExtForeignToplevelHandleV1>> for ExtForeignToplevelHandleV1

fn eq(&self, other: &Weak<ExtForeignToplevelHandleV1>) -> bool

Tests for self and other values to be equal, and is used by ==.

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 PartialEq for ExtForeignToplevelHandleV1

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

Tests for self and other values to be equal, and is used by ==.

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 Resource for ExtForeignToplevelHandleV1

type Request = Request

The request enum for this interface

type Event<'event> = Event<'event>

The event enum for this interface

fn interface() -> &'static Interface

The interface description

fn id(&self) -> ObjectId

The ID of this object

fn version(&self) -> u32

The version of this object

fn data<U>(&self) -> Option<&U>

where U: 'static,

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn Any + Sync + Send>>

Access the raw data associated with this object.

fn handle(&self) -> &WeakHandle

Access the backend handle associated with this object

fn from_id( conn: &DisplayHandle, id: ObjectId, ) -> Result<ExtForeignToplevelHandleV1, InvalidId>

Create an object resource from its ID

fn send_event( &self, evt: <ExtForeignToplevelHandleV1 as Resource>::Event<'_>, ) -> Result<(), InvalidId>

Send an event to this object

fn parse_request( conn: &DisplayHandle, msg: Message<ObjectId, OwnedFd>, ) -> Result<(ExtForeignToplevelHandleV1, <ExtForeignToplevelHandleV1 as Resource>::Request), DispatchError>

Parse a event for this object

fn write_event<'a>( &self, conn: &DisplayHandle, msg: <ExtForeignToplevelHandleV1 as Resource>::Event<'a>, ) -> Result<Message<ObjectId, BorrowedFd<'a>>, InvalidId>

Serialize an event for this object

fn client(&self) -> Option<Client>

The client owning this object

fn is_alive(&self) -> bool

Checks if the Wayland object associated with this proxy is still alive

fn post_error(&self, code: impl Into<u32>, error: impl Into<String>)

Trigger a protocol error on this object

fn downgrade(&self) -> Weak<Self>

Creates a weak handle to this object

impl Eq for ExtForeignToplevelHandleV1