Struct wayland_server::Display
source · pub struct Display { /* private fields */ }
Expand description
The wayland display
This is the core of your wayland server, this object must be kept alive as long as your server is running. It allows you to manage listening sockets and clients.
Implementations
sourceimpl Display
impl Display
sourcepub fn new<Data: 'static>(handle: LoopHandle<Data>) -> Display
pub fn new<Data: 'static>(handle: LoopHandle<Data>) -> Display
Create a new display
This method provides you a Display
and inserts it into an existing
calloop::EventLoop
.
Note that at this point, your server is not yet ready to receive connections,
your need to add listening sockets using the add_socket*
methods.
sourcepub fn get_token(&self) -> DisplayToken
pub fn get_token(&self) -> DisplayToken
Get a DisplayToken
for make non-send implementations
This is required by NewResource::implement_nonsend
.
sourcepub fn create_global<I: Interface, F>(
&mut self,
version: u32,
implementation: F
) -> Global<I>where
F: FnMut(NewResource<I>, u32) + 'static,
pub fn create_global<I: Interface, F>(
&mut self,
version: u32,
implementation: F
) -> Global<I>where
F: FnMut(NewResource<I>, u32) + 'static,
Create a new global object
This object will be advertised to all clients, and they will be able to instantiate it from their registries.
Your implementation will be called whenever a client instantiates this global.
The version specified is the highest supported version, you must be able to handle clients that choose to instantiate this global with a lower version number.
sourcepub fn create_global_with_filter<I: Interface, F1, F2>(
&mut self,
version: u32,
implementation: F1,
filter: F2
) -> Global<I>where
F1: FnMut(NewResource<I>, u32) + 'static,
F2: FnMut(Client) -> bool + 'static,
pub fn create_global_with_filter<I: Interface, F1, F2>(
&mut self,
version: u32,
implementation: F1,
filter: F2
) -> Global<I>where
F1: FnMut(NewResource<I>, u32) + 'static,
F2: FnMut(Client) -> bool + 'static,
Create a new global object with a filter
This object will be advertised to all clients, and they will be able to instantiate it from their registries.
Your implementation will be called whenever a client instantiates this global.
The version specified is the highest supported version, you must be able to handle clients that choose to instantiate this global with a lower version number.
sourcepub fn flush_clients(&self)
pub fn flush_clients(&self)
Flush events to the clients
Will send as many pending events as possible to the respective sockets of the clients. Will not block, but might not send everything if the socket buffer fills up.
sourceimpl Display
impl Display
sourcepub fn add_socket<S>(&mut self, name: Option<S>) -> IoResult<()>where
S: AsRef<OsStr>,
pub fn add_socket<S>(&mut self, name: Option<S>) -> IoResult<()>where
S: AsRef<OsStr>,
Add a listening socket to this display
Wayland clients will be able to connect to your compositor from this socket.
Socket will be created in the directory specified by the environment variable
XDG_RUNTIME_DIR
.
If a name is provided, it is used. Otherwise, if WAYLAND_DISPLAY
environment
variable is set, its contents are used as socket name. Otherwise, wayland-0
is used.
Errors if name
contains an interior null, or if XDG_RUNTIME_DIR
is not set,
or if specified could not be bound (either it is already used or the compositor
does not have the rights to create it).
sourcepub fn add_socket_auto(&mut self) -> IoResult<OsString>
pub fn add_socket_auto(&mut self) -> IoResult<OsString>
Add an automatically named listening socket to this display
Wayland clients will be able to connect to your compositor from this socket.
Socket will be created in the directory specified by the environment variable
XDG_RUNTIME_DIR
. The directory is scanned for any name in the form wayland-$d
with
0 <= $d < 32
and the first available one is used.
Errors if XDG_RUNTIME_DIR
is not set, or all 32 names are already in use.
sourcepub fn add_socket_from<T>(&mut self, socket: T) -> IoResult<()>where
T: IntoRawFd,
pub fn add_socket_from<T>(&mut self, socket: T) -> IoResult<()>where
T: IntoRawFd,
Add existing listening socket to this display
Wayland clients will be able to connect to your compositor from this socket.
The existing socket fd must already be created, opened, and locked. The fd must be properly set to CLOEXEC and bound to a socket file with both bind() and listen() already called. An error is returned otherwise.
sourcepub unsafe fn add_socket_fd(&self, fd: RawFd) -> IoResult<()>
pub unsafe fn add_socket_fd(&self, fd: RawFd) -> IoResult<()>
Add existing listening socket to this display from a raw file descriptor
Wayland clients will be able to connect to your compositor from this socket.
The library takes ownership of the provided socket if this method returns successfully.
The existing socket fd must already be created, opened, and locked. The fd must be properly set to CLOEXEC and bound to a socket file with both bind() and listen() already called. An error is returned otherwise.
sourcepub unsafe fn create_client(&self, fd: RawFd) -> Client
pub unsafe fn create_client(&self, fd: RawFd) -> Client
Create a new client to this display from an already-existing connected Fd
Auto Trait Implementations
impl !RefUnwindSafe for Display
impl !Send for Display
impl !Sync for Display
impl Unpin for Display
impl !UnwindSafe for Display
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
sourceimpl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
sourcefn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
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
. Read moresourcefn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read moresourcefn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read moresourcefn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more