Struct x11rb::protocol::sync::CounterWrapper

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

A RAII-like wrapper around a Counter.

Instances of this struct represent a Counter 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> CounterWrapper<C>

pub fn for_counter(conn: C, id: Counter) -> Self

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

pub fn counter(&self) -> Counter

Get the XID of the wrapped resource

pub fn into_counter(self) -> Counter

Assume ownership of the XID of the wrapped resource

This function destroys this wrapper without freeing the underlying resource.

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

pub fn create_counter_and_get_cookie( conn: &'c C, initial_value: Int64 ) -> Result<(Self, VoidCookie<'c, C>), ReplyOrIdError>

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

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

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

impl<C: X11Connection> CounterWrapper<C>

pub fn create_counter( conn: C, initial_value: Int64 ) -> Result<Self, ReplyOrIdError>

Create a new Counter and return a Counter wrapper

This is a thin wrapper around create_counter that allocates an id for the Counter. This function returns the resulting CounterWrapper that owns the created Counter and frees it in Drop.

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

Trait Implementations

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

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

Formats the value using the given formatter.

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

fn drop(&mut self)

Executes the destructor for this type.

impl<C: RequestConnection> From<&CounterWrapper<C>> for Counter

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

Converts to this type from the input type.