Struct x11rb::protocol::xproto::PixmapWrapper

pub struct PixmapWrapper<C: RequestConnection>(/* private fields */);

A RAII-like wrapper around a Pixmap.

Instances of this struct represent a Pixmap that is freed in Drop.

Any errors during Drop are silently ignored. Most likely an error here means that your X11 connection is broken and later requests will also fail.

Implementations

impl<C: RequestConnection> PixmapWrapper<C>

pub fn for_pixmap(conn: C, id: Pixmap) -> Self

Assume ownership of the given resource and destroy it in Drop.

pub fn pixmap(&self) -> Pixmap

Get the XID of the wrapped resource

pub fn into_pixmap(self) -> Pixmap

Assume ownership of the XID of the wrapped resource

This function destroys this wrapper without freeing the underlying resource.

impl<'c, C: X11Connection> PixmapWrapper<&'c C>

pub fn create_pixmap_and_get_cookie( conn: &'c C, depth: u8, drawable: Drawable, width: u16, height: u16 ) -> Result<(Self, VoidCookie<'c, C>), ReplyOrIdError>

Create a new Pixmap and return a Pixmap wrapper and a cookie.

This is a thin wrapper around create_pixmap that allocates an id for the Pixmap. This function returns the resulting PixmapWrapper that owns the created Pixmap and frees it in Drop. This also returns a VoidCookie that comes from the call to create_pixmap.

Errors can come from the call to X11Connection::generate_id or create_pixmap.

impl<C: X11Connection> PixmapWrapper<C>

pub fn create_pixmap( conn: C, depth: u8, drawable: Drawable, width: u16, height: u16 ) -> Result<Self, ReplyOrIdError>

Create a new Pixmap and return a Pixmap wrapper

This is a thin wrapper around create_pixmap that allocates an id for the Pixmap. This function returns the resulting PixmapWrapper that owns the created Pixmap and frees it in Drop.

Errors can come from the call to X11Connection::generate_id or create_pixmap.

Trait Implementations

impl<C: Debug + RequestConnection> Debug for PixmapWrapper<C>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<C: RequestConnection> Drop for PixmapWrapper<C>

fn drop(&mut self)

Executes the destructor for this type.

impl<C: RequestConnection> From<&PixmapWrapper<C>> for Pixmap

fn from(from: &PixmapWrapper<C>) -> Self

Converts to this type from the input type.