Struct x11rb::protocol::xproto::CursorWrapper

source ·
pub struct CursorWrapper<C: RequestConnection>(C, Cursor);
Expand description

A RAII-like wrapper around a Cursor.

Instances of this struct represent a Cursor 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.

Tuple Fields§

§0: C§1: Cursor

Implementations§

source§

impl<C: RequestConnection> CursorWrapper<C>

source

pub fn for_cursor(conn: C, id: Cursor) -> Self

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

source

pub fn cursor(&self) -> Cursor

Get the XID of the wrapped resource

source

pub fn into_cursor(self) -> Cursor

Assume ownership of the XID of the wrapped resource

This function destroys this wrapper without freeing the underlying resource.

source§

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

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

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

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

source§

impl<C: X11Connection> CursorWrapper<C>

source

pub fn create_cursor<A>( conn: C, source: Pixmap, mask: A, fore_red: u16, fore_green: u16, fore_blue: u16, back_red: u16, back_green: u16, back_blue: u16, x: u16, y: u16, ) -> Result<Self, ReplyOrIdError>
where A: Into<Pixmap>,

Create a new Cursor and return a Cursor wrapper

This is a thin wrapper around create_cursor that allocates an id for the Cursor. This function returns the resulting CursorWrapper that owns the created Cursor and frees it in Drop.

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

source§

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

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

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

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

source§

impl<C: X11Connection> CursorWrapper<C>

source

pub fn create_glyph_cursor<A>( conn: C, source_font: Font, mask_font: A, source_char: u16, mask_char: u16, fore_red: u16, fore_green: u16, fore_blue: u16, back_red: u16, back_green: u16, back_blue: u16, ) -> Result<Self, ReplyOrIdError>
where A: Into<Font>,

Create a new Cursor and return a Cursor wrapper

This is a thin wrapper around create_glyph_cursor that allocates an id for the Cursor. This function returns the resulting CursorWrapper that owns the created Cursor and frees it in Drop.

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

Trait Implementations§

source§

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

source§

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

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

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

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<C: RequestConnection> From<&CursorWrapper<C>> for Cursor

source§

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

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<C> Freeze for CursorWrapper<C>
where C: Freeze,

§

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

§

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

§

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

§

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

§

impl<C> UnwindSafe for CursorWrapper<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.