Struct RegionWrapper

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

A RAII-like wrapper around a Region.

Instances of this struct represent a Region 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> RegionWrapper<C>

pub fn for_region(conn: C, id: Region) -> Self

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

pub fn region(&self) -> Region

Get the XID of the wrapped resource

pub fn into_region(self) -> Region

Assume ownership of the XID of the wrapped resource

This function destroys this wrapper without freeing the underlying resource.

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

pub fn create_region_and_get_cookie( conn: &'c C, rectangles: &[Rectangle], ) -> Result<(Self, VoidCookie<'c, C>), ReplyOrIdError>

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

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

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

impl<C: X11Connection> RegionWrapper<C>

pub fn create_region( conn: C, rectangles: &[Rectangle], ) -> Result<Self, ReplyOrIdError>

Create a new Region and return a Region wrapper

This is a thin wrapper around create_region that allocates an id for the Region. This function returns the resulting RegionWrapper that owns the created Region and frees it in Drop.

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

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

pub fn create_region_from_bitmap_and_get_cookie( conn: &'c C, bitmap: Pixmap, ) -> Result<(Self, VoidCookie<'c, C>), ReplyOrIdError>

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

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

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

impl<C: X11Connection> RegionWrapper<C>

pub fn create_region_from_bitmap( conn: C, bitmap: Pixmap, ) -> Result<Self, ReplyOrIdError>

Create a new Region and return a Region wrapper

This is a thin wrapper around create_region_from_bitmap that allocates an id for the Region. This function returns the resulting RegionWrapper that owns the created Region and frees it in Drop.

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

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

pub fn create_region_from_window_and_get_cookie( conn: &'c C, window: Window, kind: SK, ) -> Result<(Self, VoidCookie<'c, C>), ReplyOrIdError>

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

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

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

impl<C: X11Connection> RegionWrapper<C>

pub fn create_region_from_window( conn: C, window: Window, kind: SK, ) -> Result<Self, ReplyOrIdError>

Create a new Region and return a Region wrapper

This is a thin wrapper around create_region_from_window that allocates an id for the Region. This function returns the resulting RegionWrapper that owns the created Region and frees it in Drop.

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

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

pub fn create_region_from_gc_and_get_cookie( conn: &'c C, gc: Gcontext, ) -> Result<(Self, VoidCookie<'c, C>), ReplyOrIdError>

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

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

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

impl<C: X11Connection> RegionWrapper<C>

pub fn create_region_from_gc( conn: C, gc: Gcontext, ) -> Result<Self, ReplyOrIdError>

Create a new Region and return a Region wrapper

This is a thin wrapper around create_region_from_gc that allocates an id for the Region. This function returns the resulting RegionWrapper that owns the created Region and frees it in Drop.

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

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

pub fn create_region_from_picture_and_get_cookie( conn: &'c C, picture: Picture, ) -> Result<(Self, VoidCookie<'c, C>), ReplyOrIdError>

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

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

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

impl<C: X11Connection> RegionWrapper<C>

pub fn create_region_from_picture( conn: C, picture: Picture, ) -> Result<Self, ReplyOrIdError>

Create a new Region and return a Region wrapper

This is a thin wrapper around create_region_from_picture that allocates an id for the Region. This function returns the resulting RegionWrapper that owns the created Region and frees it in Drop.

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

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

pub fn composite_create_region_from_border_clip_and_get_cookie( conn: &'c C, window: Window, ) -> Result<(Self, VoidCookie<'c, C>), ReplyOrIdError>

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

This is a thin wrapper around super::composite::create_region_from_border_clip that allocates an id for the Region. This function returns the resulting RegionWrapper that owns the created Region and frees it in Drop. This also returns a VoidCookie that comes from the call to super::composite::create_region_from_border_clip.

Errors can come from the call to X11Connection::generate_id or super::composite::create_region_from_border_clip.

impl<C: X11Connection> RegionWrapper<C>

pub fn composite_create_region_from_border_clip( conn: C, window: Window, ) -> Result<Self, ReplyOrIdError>

Create a new Region and return a Region wrapper

This is a thin wrapper around super::composite::create_region_from_border_clip that allocates an id for the Region. This function returns the resulting RegionWrapper that owns the created Region and frees it in Drop.

Errors can come from the call to X11Connection::generate_id or super::composite::create_region_from_border_clip.

Trait Implementations

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

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

Formats the value using the given formatter.

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

fn drop(&mut self)

Executes the destructor for this type.

impl<C: RequestConnection> From<&RegionWrapper<C>> for Region

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

Converts to this type from the input type.