Struct x11rb::cookie::VoidCookie

pub struct VoidCookie<'a, C>
where
    C: RequestConnection + ?Sized,
{
    connection: &'a C,
    sequence_number: SequenceNumber,
}

A handle to a possible error from the X11 server.

When sending a request for which no reply is expected, this library returns a VoidCookie. This VoidCookie can then later be used to check if the X11 server sent an error.

See crate::cookie for infos on the different ways to handle X11 errors in response to a request.

Fields

connection: &'a C

sequence_number: SequenceNumber

Implementations

impl<'a, C> VoidCookie<'a, C>

where C: RequestConnection + ?Sized,

pub fn new(connection: &C, sequence_number: SequenceNumber) -> VoidCookie<'_, C>

Construct a new cookie.

This function should only be used by implementations of Connection::send_request_without_reply.

pub fn sequence_number(&self) -> SequenceNumber

Get the sequence number of the request that generated this cookie.

fn consume(self) -> (&'a C, SequenceNumber)

pub fn check(self) -> Result<(), ReplyError>

Check if the original request caused an X11 error.

pub fn ignore_error(self)

Ignore all errors to this request.

Without calling this method, an error becomes available on the connection as an event after this cookie was dropped. This function causes errors to be ignored instead.

pub(crate) fn replace_connection<C2: RequestConnection + ?Sized>( self, connection: &C2, ) -> VoidCookie<'_, C2>

Move this cookie to refer to another connection instance.

This function may only be used if both connections are “basically the same”. For example, a Cookie for a connection C can be moved to Rc<C> since that still refers to the same underlying connection.

Trait Implementations

impl<'a, C> Debug for VoidCookie<'a, C>

where C: RequestConnection + ?Sized + Debug,

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

Formats the value using the given formatter.

impl<C> Drop for VoidCookie<'_, C>

where C: RequestConnection + ?Sized,

fn drop(&mut self)

Executes the destructor for this type.