Struct x11rb::protocol::sync::AlarmWrapper

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

A RAII-like wrapper around a Alarm.

Instances of this struct represent a Alarm 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> AlarmWrapper<C>

pub fn for_alarm(conn: C, id: Alarm) -> Self

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

pub fn alarm(&self) -> Alarm

Get the XID of the wrapped resource

pub fn into_alarm(self) -> Alarm

Assume ownership of the XID of the wrapped resource

This function destroys this wrapper without freeing the underlying resource.

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

pub fn create_alarm_and_get_cookie( conn: &'c C, value_list: &CreateAlarmAux ) -> Result<(Self, VoidCookie<'c, C>), ReplyOrIdError>

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

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

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

impl<C: X11Connection> AlarmWrapper<C>

pub fn create_alarm( conn: C, value_list: &CreateAlarmAux ) -> Result<Self, ReplyOrIdError>

Create a new Alarm and return a Alarm wrapper

This is a thin wrapper around create_alarm that allocates an id for the Alarm. This function returns the resulting AlarmWrapper that owns the created Alarm and frees it in Drop.

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

Trait Implementations

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

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

Formats the value using the given formatter.

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

fn drop(&mut self)

Executes the destructor for this type.

impl<C: RequestConnection> From<&AlarmWrapper<C>> for Alarm

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

Converts to this type from the input type.