Struct XxSessionV1

pub struct XxSessionV1 { /* private fields */ }

Available on crate feature client 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 Event enum for this interface.

Implementations

impl XxSessionV1

pub fn destroy(&self)

Destroy the session

Destroy a session object, preserving the current state but not continuing to make further updates if state changes occur. This makes the associated xx_toplevel_session_v1 objects inert.

pub fn remove(&self)

Remove the session

Remove the session, making it no longer available for restoration. A compositor should in response to this request remove the data related to this session from its storage.

pub fn add_toplevel<U: Send + Sync + 'static, D: Dispatch<XxToplevelSessionV1, U> + 'static>( &self, toplevel: &XdgToplevel, name: String, qh: &QueueHandle<D>, udata: U, ) -> XxToplevelSessionV1

add a new surface to the session

Attempt to add a given surface to the session. The passed name is used to identify what window is being restored, and may be used store window specific state within the session.

Calling this with a toplevel that is already managed by the session with the same associated will raise an in_use error.

pub fn restore_toplevel<U: Send + Sync + 'static, D: Dispatch<XxToplevelSessionV1, U> + 'static>( &self, toplevel: &XdgToplevel, name: String, qh: &QueueHandle<D>, udata: U, ) -> XxToplevelSessionV1

restore a surface state

Inform the compositor that the toplevel associated with the passed name should have its window management state restored.

Calling this with a toplevel that is already managed by the session with the same associated will raise an in_use error.

This request must be called prior to the first commit on the associated wl_surface, otherwise an already_mapped error is raised.

As part of the initial configure sequence, if the toplevel was successfully restored, a xx_toplevel_session_v1.restored event is emitted. See the xx_toplevel_session_v1.restored event for further details.

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

type Request<'request> = Request<'request>

The request enum for this interface

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

Access the user-data associated with this object

fn object_data(&self) -> Option<&Arc<dyn ObjectData>>

Access the raw data associated with this object.

fn backend(&self) -> &WeakBackend

Access the backend associated with this object

fn send_request(&self, req: Self::Request<'_>) -> Result<(), InvalidId>

Send a request for this object.

fn send_constructor<I: Proxy>( &self, req: Self::Request<'_>, data: Arc<dyn ObjectData>, ) -> Result<I, InvalidId>

Send a request for this object that creates another object.

fn from_id(conn: &Connection, id: ObjectId) -> Result<Self, InvalidId>

Create an object proxy from its ID

fn inert(backend: WeakBackend) -> Self

Create an inert object proxy

fn parse_event( conn: &Connection, msg: Message<ObjectId, OwnedFd>, ) -> Result<(Self, Self::Event), DispatchError>

Parse a event for this object

fn write_request<'a>( &self, conn: &Connection, msg: Self::Request<'a>, ) -> Result<(Message<ObjectId, BorrowedFd<'a>>, Option<(&'static Interface, u32)>), InvalidId>

Serialize a request for this object

fn is_alive(&self) -> bool

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

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

Creates a weak handle to this object

impl Eq for XxSessionV1