Struct x11rb::protocol::xproto::ColormapWrapper

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

A RAII-like wrapper around a Colormap.

Instances of this struct represent a Colormap 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> ColormapWrapper<C>

pub fn for_colormap(conn: C, id: Colormap) -> Self

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

pub fn colormap(&self) -> Colormap

Get the XID of the wrapped resource

pub fn into_colormap(self) -> Colormap

Assume ownership of the XID of the wrapped resource

This function destroys this wrapper without freeing the underlying resource.

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

pub fn create_colormap_and_get_cookie( conn: &'c C, alloc: ColormapAlloc, window: Window, visual: Visualid ) -> Result<(Self, VoidCookie<'c, C>), ReplyOrIdError>

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

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

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

impl<C: X11Connection> ColormapWrapper<C>

pub fn create_colormap( conn: C, alloc: ColormapAlloc, window: Window, visual: Visualid ) -> Result<Self, ReplyOrIdError>

Create a new Colormap and return a Colormap wrapper

This is a thin wrapper around create_colormap that allocates an id for the Colormap. This function returns the resulting ColormapWrapper that owns the created Colormap and frees it in Drop.

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

Trait Implementations

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

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

Formats the value using the given formatter.

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

fn drop(&mut self)

Executes the destructor for this type.

impl<C: RequestConnection> From<&ColormapWrapper<C>> for Colormap

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

Converts to this type from the input type.