[−][src]Struct wayland_client::Display
A connection to a wayland server
This object both represent the connection to the server and contains the
primary WlDisplay
wayland object. As such, it must be kept alive as long
as you are connected. You can access the contained WlDisplay
via Deref
to create all the objects you need.
Methods
impl Display
[src]
pub fn connect_to_env() -> Result<Display, ConnectError>
[src]
Attempt to connect to a wayland server using the contents of the environment variables
First of all, if the WAYLAND_SOCKET
environment variable is set, it'll try to interpret
it as a FD number to use
Otherwise, it will try to connect to the socket name defined in the WAYLAND_DISPLAY
environment variable, and error if it is not set.
On success, you are given the Display
object as well as the main EventQueue
hosting
the WlDisplay
wayland object.
This requires the XDG_RUNTIME_DIR
variable to be properly set.
pub fn connect_to_name<S: Into<OsString>>(
name: S
) -> Result<Display, ConnectError>
[src]
name: S
) -> Result<Display, ConnectError>
Attempt to connect to a wayland server socket with given name
On success, you are given the Display
object as well as the main EventQueue
hosting
the WlDisplay
wayland object.
This requires the XDG_RUNTIME_DIR
variable to be properly set.
pub unsafe fn from_fd(fd: RawFd) -> Result<Display, ConnectError>
[src]
Attempt to use an already connected unix socket on given FD to start a wayland connection
On success, you are given the Display
object as well as the main EventQueue
hosting
the WlDisplay
wayland object.
Will take ownership of the FD.
pub fn flush(&self) -> Result<()>
[src]
Non-blocking write to the server
Outgoing messages to the server are buffered by the library for efficiency. This method flushes the internal buffer to the server socket.
Will write as many pending requests as possible to the server socket. Never blocks: if not all
requests could be written, will return an io error WouldBlock
.
On success returns the number of written requests.
pub fn create_event_queue(&self) -> EventQueue
[src]
Create a new event queue associated with this wayland connection
pub fn protocol_error(&self) -> Option<ProtocolError>
[src]
Retrieve the last protocol error if any occured
If your client does not respect some part of a protocol it is using, the server will send a special "protocol error" event and kill your connection. This method allows you to retrieve the contents of this event if it occured.
If the dispatch methods of the EventQueue
return an error, this is an indication
that a protocol error may have occured. Such errors are not recoverable, but this
method allows you to gracefully display them to the user, along with indications for
submitting a bug-report for example.
Methods from Deref<Target = Proxy<WlDisplay>>
pub fn send<J>(&self, msg: I::Request, version: Option<u32>) -> Option<Main<J>> where
J: Interface + AsRef<Proxy<J>> + From<Proxy<J>>,
[src]
J: Interface + AsRef<Proxy<J>> + From<Proxy<J>>,
Send a request creating an object through this object
Warning: This method is mostly intended to be used by code generated
by wayland-scanner
, and you should probably never need to use it directly,
but rather use the appropriate methods on the Rust object.
This is the generic method to send requests
pub fn is_alive(&self) -> bool
[src]
Check if the object associated with this proxy is still alive
Will return false
if the object has been destroyed.
If the object is not managed by this library, this will always
returns true
.
pub fn version(&self) -> u32
[src]
Retrieve the interface version of this wayland object instance
Returns 0 on dead objects
pub fn id(&self) -> u32
[src]
Retrieve the object id of this wayland object
pub fn user_data(&self) -> &UserData
[src]
Access the UserData associated to this object
Each wayland object has an associated UserData, that can store a payload of arbitrary type and is shared by all proxies of this object.
See UserData documentation for more details.
pub fn equals(&self, other: &Proxy<I>) -> bool
[src]
Check if the other proxy refers to the same underlying wayland object
pub fn is_external(&self) -> bool
[src]
Check whether this proxy is managed by the library or not
See from_c_ptr
for details.
NOTE: This method will panic if called while the use_system_lib
feature is
not activated.
pub fn c_ptr(&self) -> *mut wl_proxy
[src]
Get a raw pointer to the underlying wayland object
Retrieve a pointer to the object from the libwayland-client.so
library.
You will mostly need it to interface with C libraries needing access
to wayland objects (to initialize an opengl context for example).
NOTE: This method will panic if called while the use_system_lib
feature is
not activated.
Trait Implementations
Auto Trait Implementations
impl Send for Display
impl Unpin for Display
impl Sync for Display
impl !UnwindSafe for Display
impl !RefUnwindSafe for Display
Blanket Implementations
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Downcast for T where
T: Any,
[src]
T: Any,