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 you need to import the associated RequestsTrait trait from the module of this interface.

Methods

impl<I: Interface> Proxy<I>

pub fn send(&self, msg: I::Request)

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 RequestsTrait for your proxy.

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<Proxy<J>, ()> where
    J: Interface,
    F: FnOnce(NewProxy<J>) -> 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 RequestsTrait for your proxy.

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

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

Retrieve the interface version of this wayland object instance

Returns 0 on dead objects

pub fn id(&self) -> u32

Retrieve the object id of this wayland object

pub fn user_data<UD: 'static>(&self) -> Option<&UD>

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<I>) -> bool

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

pub fn child<C: Interface>(&self) -> NewProxy<C>

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 RequestsTrait for your proxy.

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>

Creates a handle of this proxy with its actual type erased

pub fn make_wrapper(&self, queue: &QueueToken) -> Result<Proxy<I>, ()>

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>(&self) -> Proxy<J>

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 RequestsTrait for your proxy.

impl<I: Interface> Proxy<I>

pub fn is_external(&self) -> bool

Check whether this proxy is managed by the library or not

See from_c_ptr for details.

pub fn c_ptr(&self) -> *mut wl_proxy

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).

pub unsafe fn from_c_ptr(ptr: *mut wl_proxy) -> Proxy<I>

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.

Trait Implementations

impl RequestsTrait for Proxy<WlDisplay>

fn sync<F>(&self, implementor: F) -> Result<Proxy<WlCallback>, ()> where
    F: FnOnce(NewProxy<WlCallback>) -> Proxy<WlCallback>, 

asynchronous roundtrip

fn get_registry<F>(&self, implementor: F) -> Result<Proxy<WlRegistry>, ()> where
    F: FnOnce(NewProxy<WlRegistry>) -> Proxy<WlRegistry>, 

get global registry object

impl RequestsTrait for Proxy<WlRegistry>

fn bind<T: Interface, F>(
    &self,
    version: u32,
    name: u32,
    implementor: F
) -> Result<Proxy<T>, ()> where
    F: FnOnce(NewProxy<T>) -> Proxy<T>, 

bind an object to the display

impl RequestsTrait for Proxy<WlCallback>

impl RequestsTrait for Proxy<WlCompositor>

fn create_surface<F>(&self, implementor: F) -> Result<Proxy<WlSurface>, ()> where
    F: FnOnce(NewProxy<WlSurface>) -> Proxy<WlSurface>, 

create new surface

fn create_region<F>(&self, implementor: F) -> Result<Proxy<WlRegion>, ()> where
    F: FnOnce(NewProxy<WlRegion>) -> Proxy<WlRegion>, 

create new region

impl RequestsTrait for Proxy<WlShmPool>

fn create_buffer<F>(
    &self,
    offset: i32,
    width: i32,
    height: i32,
    stride: i32,
    format: Format,
    implementor: F
) -> Result<Proxy<WlBuffer>, ()> where
    F: FnOnce(NewProxy<WlBuffer>) -> Proxy<WlBuffer>, 

create a buffer from the pool

fn destroy(&self)

destroy the pool

fn resize(&self, size: i32)

change the size of the pool mapping

impl RequestsTrait for Proxy<WlShm>

fn create_pool<F>(
    &self,
    fd: RawFd,
    size: i32,
    implementor: F
) -> Result<Proxy<WlShmPool>, ()> where
    F: FnOnce(NewProxy<WlShmPool>) -> Proxy<WlShmPool>, 

create a shm pool

impl RequestsTrait for Proxy<WlBuffer>

fn destroy(&self)

destroy a buffer

impl RequestsTrait for Proxy<WlDataOffer>

fn accept(&self, serial: u32, mime_type: Option<String>)

accept one of the offered mime types

fn receive(&self, mime_type: String, fd: RawFd)

request that the data is transferred

fn destroy(&self)

destroy data offer

fn finish(&self)

the offer will no longer be used

fn set_actions(&self, dnd_actions: u32, preferred_action: u32)

set the available/preferred drag-and-drop actions

impl RequestsTrait for Proxy<WlDataSource>

fn offer(&self, mime_type: String)

add an offered mime type

fn destroy(&self)

destroy the data source

fn set_actions(&self, dnd_actions: u32)

set the available drag-and-drop actions

impl RequestsTrait for Proxy<WlDataDevice>

fn start_drag(
    &self,
    source: Option<&Proxy<WlDataSource>>,
    origin: &Proxy<WlSurface>,
    icon: Option<&Proxy<WlSurface>>,
    serial: u32
)

start drag-and-drop operation

fn set_selection(&self, source: Option<&Proxy<WlDataSource>>, serial: u32)

copy data to the selection

fn release(&self)

destroy data device

impl RequestsTrait for Proxy<WlDataDeviceManager>

fn create_data_source<F>(
    &self,
    implementor: F
) -> Result<Proxy<WlDataSource>, ()> where
    F: FnOnce(NewProxy<WlDataSource>) -> Proxy<WlDataSource>, 

create a new data source

fn get_data_device<F>(
    &self,
    seat: &Proxy<WlSeat>,
    implementor: F
) -> Result<Proxy<WlDataDevice>, ()> where
    F: FnOnce(NewProxy<WlDataDevice>) -> Proxy<WlDataDevice>, 

create a new data device

impl RequestsTrait for Proxy<WlShell>

fn get_shell_surface<F>(
    &self,
    surface: &Proxy<WlSurface>,
    implementor: F
) -> Result<Proxy<WlShellSurface>, ()> where
    F: FnOnce(NewProxy<WlShellSurface>) -> Proxy<WlShellSurface>, 

create a shell surface from a surface

impl RequestsTrait for Proxy<WlShellSurface>

fn pong(&self, serial: u32)

respond to a ping event

fn _move(&self, seat: &Proxy<WlSeat>, serial: u32)

start an interactive move

fn resize(&self, seat: &Proxy<WlSeat>, serial: u32, edges: Resize)

start an interactive resize

fn set_toplevel(&self)

make the surface a toplevel surface

fn set_transient(
    &self,
    parent: &Proxy<WlSurface>,
    x: i32,
    y: i32,
    flags: Transient
)

make the surface a transient surface

fn set_fullscreen(
    &self,
    method: FullscreenMethod,
    framerate: u32,
    output: Option<&Proxy<WlOutput>>
)

make the surface a fullscreen surface

fn set_popup(
    &self,
    seat: &Proxy<WlSeat>,
    serial: u32,
    parent: &Proxy<WlSurface>,
    x: i32,
    y: i32,
    flags: Transient
)

make the surface a popup surface

fn set_maximized(&self, output: Option<&Proxy<WlOutput>>)

make the surface a maximized surface

fn set_title(&self, title: String)

set surface title

fn set_class(&self, class_: String)

set surface class

impl RequestsTrait for Proxy<WlSurface>

fn destroy(&self)

delete surface

fn attach(&self, buffer: Option<&Proxy<WlBuffer>>, x: i32, y: i32)

set the surface contents

fn damage(&self, x: i32, y: i32, width: i32, height: i32)

mark part of the surface damaged

fn frame<F>(&self, implementor: F) -> Result<Proxy<WlCallback>, ()> where
    F: FnOnce(NewProxy<WlCallback>) -> Proxy<WlCallback>, 

request a frame throttling hint

fn set_opaque_region(&self, region: Option<&Proxy<WlRegion>>)

set opaque region

fn set_input_region(&self, region: Option<&Proxy<WlRegion>>)

set input region

fn commit(&self)

commit pending surface state

fn set_buffer_transform(&self, transform: Transform)

sets the buffer transformation

fn set_buffer_scale(&self, scale: i32)

sets the buffer scaling factor

fn damage_buffer(&self, x: i32, y: i32, width: i32, height: i32)

mark part of the surface damaged using buffer coordinates

impl RequestsTrait for Proxy<WlSeat>

fn get_pointer<F>(&self, implementor: F) -> Result<Proxy<WlPointer>, ()> where
    F: FnOnce(NewProxy<WlPointer>) -> Proxy<WlPointer>, 

return pointer object

fn get_keyboard<F>(&self, implementor: F) -> Result<Proxy<WlKeyboard>, ()> where
    F: FnOnce(NewProxy<WlKeyboard>) -> Proxy<WlKeyboard>, 

return keyboard object

fn get_touch<F>(&self, implementor: F) -> Result<Proxy<WlTouch>, ()> where
    F: FnOnce(NewProxy<WlTouch>) -> Proxy<WlTouch>, 

return touch object

fn release(&self)

release the seat object

impl RequestsTrait for Proxy<WlPointer>

fn set_cursor(
    &self,
    serial: u32,
    surface: Option<&Proxy<WlSurface>>,
    hotspot_x: i32,
    hotspot_y: i32
)

set the pointer surface

fn release(&self)

release the pointer object

impl RequestsTrait for Proxy<WlKeyboard>

fn release(&self)

release the keyboard object

impl RequestsTrait for Proxy<WlTouch>

fn release(&self)

release the touch object

impl RequestsTrait for Proxy<WlOutput>

fn release(&self)

release the output object

impl RequestsTrait for Proxy<WlRegion>

fn destroy(&self)

destroy region

fn add(&self, x: i32, y: i32, width: i32, height: i32)

add rectangle to region

fn subtract(&self, x: i32, y: i32, width: i32, height: i32)

subtract rectangle from region

impl RequestsTrait for Proxy<WlSubcompositor>

fn destroy(&self)

unbind from the subcompositor interface

fn get_subsurface<F>(
    &self,
    surface: &Proxy<WlSurface>,
    parent: &Proxy<WlSurface>,
    implementor: F
) -> Result<Proxy<WlSubsurface>, ()> where
    F: FnOnce(NewProxy<WlSubsurface>) -> Proxy<WlSubsurface>, 

give a surface the role sub-surface

impl RequestsTrait for Proxy<WlSubsurface>

fn destroy(&self)

remove sub-surface interface

fn set_position(&self, x: i32, y: i32)

reposition the sub-surface

fn place_above(&self, sibling: &Proxy<WlSurface>)

restack the sub-surface

fn place_below(&self, sibling: &Proxy<WlSurface>)

restack the sub-surface

fn set_sync(&self)

set sub-surface to synchronized mode

fn set_desync(&self)

set sub-surface to desynchronized mode

impl<I: Interface> Eq for Proxy<I>

impl<I: Interface> Clone for Proxy<I>

fn clone(&self) -> Proxy<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: Interface> PartialEq<Proxy<I>> for Proxy<I>

fn eq(&self, other: &Proxy<I>) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.