Struct XxSessionV1

pub struct XxSessionV1 { /* private fields */ }

Available on crate feature server only.

A session for an application

A xx_session_v1 object represents a session for an application. While the object exists, all surfaces which have been added to the session will have states stored by the compositor which can be reapplied at a later time. Two sessions cannot exist for the same identifier string.

States for surfaces added to a session are automatically updated by the compositor when they are changed.

Surfaces which have been added to a session are automatically removed from the session if xdg_toplevel.destroy is called for the surface.

See also the Request enum for this interface.

Implementations

impl XxSessionV1

pub fn created(&self, id: String)

newly-created session id

Emitted at most once some time after getting a new session object. It means that no previous state was restored, and a new session was created. The passed id can be used to restore previous sessions.

pub fn restored(&self)

the session has been restored

Emitted at most once some time after getting a new session object. It means that previous state was at least partially restored. The same id can again be used to restore previous sessions.

pub fn replaced(&self)

the session has been restored

Emitted at most once, if the session was taken over by some other client. When this happens, the session and all its toplevel session objects become inert, and should be destroyed.

Trait Implementations

impl Borrow<ObjectId> for XxSessionV1

fn borrow(&self) -> &ObjectId

Immutably borrows from an owned value.

impl Clone for XxSessionV1

fn clone(&self) -> XxSessionV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XxSessionV1

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

Formats the value using the given formatter.

impl Hash for XxSessionV1

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

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<XxSessionV1>> for XxSessionV1

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

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

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: 'static>(&self) -> Option<&U>

Access the user-data associated with this object

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

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<Self, InvalidId>

Create an object resource from its ID

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

Send an event to this object

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

Parse a event for this object

fn write_event<'a>( &self, conn: &DisplayHandle, msg: Self::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 XxSessionV1