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

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§

source§

impl<C: RequestConnection> RegionWrapper<C>

source

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

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

source

pub fn region(&self) -> Region

Get the XID of the wrapped resource

source

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.

source§

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

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.

source§

impl<C: X11Connection> RegionWrapper<C>

source

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.

source§

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

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.

source§

impl<C: X11Connection> RegionWrapper<C>

source

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.

source§

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

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.

source§

impl<C: X11Connection> RegionWrapper<C>

source

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.

source§

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

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.

source§

impl<C: X11Connection> RegionWrapper<C>

source

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.

source§

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

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.

source§

impl<C: X11Connection> RegionWrapper<C>

source

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.

Trait Implementations§

source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

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

source§

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

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<C> RefUnwindSafe for RegionWrapper<C>
where C: RefUnwindSafe,

§

impl<C> Send for RegionWrapper<C>
where C: Send,

§

impl<C> Sync for RegionWrapper<C>
where C: Sync,

§

impl<C> Unpin for RegionWrapper<C>
where C: Unpin,

§

impl<C> UnwindSafe for RegionWrapper<C>
where C: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.