[−][src]Struct wayland_client::Proxy

pub struct Proxy<I: Interface> { /* fields omitted */ }

An handle to a wayland proxy

This represents a wayland object instantiated in your client session. Several handles to the same object can exist at a given time, and cloning them won't create a new protocol object, only clone the handle. The lifetime of the protocol object is not tied to the lifetime of these handles, but rather to sending or receiving destroying messages.

These handles are notably used to send requests to the server. To do this you need to convert them to the corresponding Rust object (using .into()) and use methods on the Rust object.

Methods

`impl<I: Interface> Proxy`[src]

`pub fn send(&self, msg: I::Request)`[src]

Send a request 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.

If your request needs to create an object, use send_constructor.

`pub fn send_constructor<J, F>( &self, msg: I::Request, implementor: F, version: Option<u32> ) -> Result<J, ()> where J: Interface + From<Proxy<J>>, F: FnOnce(NewProxy<J>) -> J,` [src]

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 that create objects

The slot in the message corresponding with the newly created object must have been filled by a placeholder object (see child_placeholder).

`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<UD: 'static>(&self) -> Option<&UD>`[src]

Access the arbitrary payload associated to this object

You need to specify the expected type of this payload, and this function will return None if either the types don't match or you are attempting to access a non Send + Sync user data from the wrong thread.

This value is associated to the Proxy when you implement it, and you cannot access it mutably afterwards. If you need interior mutability, you are responsible for using a Mutex or similar type to achieve it.

`pub fn equals(&self, other: &Proxy) -> bool`[src]

Check if the other proxy refers to the same underlying wayland object

`pub fn child<C: Interface>(&self) -> NewProxy<C>`[src]

Create a new child 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 creates a new wayland object, considered as a child of this object. It will notably inherit its interface version.

The created object should immediately be implemented and sent in a request to the server, to keep the object list properly synchronized. Failure to do so will likely cause a protocol error.

`pub fn anonymize(&self) -> Proxy<AnonymousObject>`[src]

Creates a handle of this proxy with its actual type erased

`pub fn make_wrapper(&self, queue: &QueueToken) -> Result<I, ()> where I: From<Proxy>,` [src]

Create a wrapper for this object for queue management

As assigning a proxy to an event queue can be a racy operation in contexts involving multiple thread, this provides a facility to do this safely.

The wrapper object created behaves like a regular Proxy, except that all objects created as the result of its requests will be assigned to the queue associated to the provided token, rather than the queue of their parent. This does not change the queue of the proxy itself.

`pub fn child_placeholder<J: Interface + From<Proxy<J>>>(&self) -> J`[src]

Create a placeholder object, to be used with send_constructor

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.

`impl<I: Interface> Proxy`[src]

`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 native_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 native_lib feature is not activated.

`pub unsafe fn from_c_ptr(_ptr: *mut wl_proxy) -> Proxy where I: From<Proxy>,` [src]

Create a Proxy instance from a C pointer

Create a Proxy from a raw pointer to a wayland object from the C library.

If the pointer was previously obtained by the c_ptr() method, this constructs a new proxy for the same object just like the clone() method would have.

If the object was created by some other C library you are interfacing with, it will be created in an "unmanaged" state: wayland-client will treat it as foreign, and as such most of the safeties will be absent. Notably the lifetime of the object can't be tracked, so the alive() method will always return false and you are responsible of not using an object past its destruction (as this would cause a protocol error). You will also be unable to associate any user data pointer to this object.

In order to handle protocol races, invoking it with a NULL pointer will create an already-dead object.

NOTE: This method will panic if called while the native_lib feature is not activated.