Struct SpecialEventDisplay 

pub struct SpecialEventDisplay<Dpy: ?Sized> { /* private fields */ }

A special type of Display that provides queues for special events.

See the module level documentation for more information.

Implementations

impl<Dpy> SpecialEventDisplay<Dpy>

pub fn into_inner(self) -> Dpy

Get the inner display type.

impl<Dpy: ?Sized> SpecialEventDisplay<Dpy>

pub fn create_special_event_queue( &mut self, classifier: impl FnMut(&Event) -> bool + Send + Sync + 'static, ) -> usize

Create a new special event queue with the given classifier.

Returns the key to be used to poll the event queue.

pub fn remove_special_event_queue(&mut self, key: usize)

Remove the special event queue with the given key.

impl<Dpy: DisplayBase + ?Sized> SpecialEventDisplay<Dpy>

pub fn poll_for_special_event(&mut self, key: usize) -> Result<Option<Event>>

Poll for a special event for the given queue.

impl<Dpy: Display + ?Sized> SpecialEventDisplay<Dpy>

pub fn wait_for_special_event(&mut self, key: usize) -> Result<Event>

Wait for a special event from the given queue.

impl<Dpy: AsyncDisplay + ?Sized> SpecialEventDisplay<Dpy>

pub async fn wait_for_special_event_async( &mut self, key: usize, ) -> Result<Event>

Wait for a speical event from the given queue.

Trait Implementations

impl<Dpy: ?Sized> AsMut<Dpy> for SpecialEventDisplay<Dpy>

fn as_mut(&mut self) -> &mut Dpy

Converts this type into a mutable reference of the (usually inferred) input type.

impl<Dpy: ?Sized> AsRef<Dpy> for SpecialEventDisplay<Dpy>

fn as_ref(&self) -> &Dpy

Converts this type into a shared reference of the (usually inferred) input type.

impl<D: AsyncDisplay + ?Sized> AsyncDisplay for SpecialEventDisplay<D>

fn poll_for_interest( &mut self, interest: Interest, callback: &mut dyn FnMut(&mut dyn AsyncDisplay, &mut Context<'_>) -> Result<()>, ctx: &mut Context<'_>, ) -> Poll<Result<()>>

Poll for an interest. If the interest if ready, call the provided callback.

impl<D: CanBeAsyncDisplay + ?Sized> CanBeAsyncDisplay for SpecialEventDisplay<D>

fn format_request( &mut self, req: &mut RawRequest<'_, '_>, ctx: &mut Context<'_>, ) -> Result<AsyncStatus<u64>>

Partially format the request.

fn try_flush(&mut self, ctx: &mut Context<'_>) -> Result<AsyncStatus<()>>

Flush the output buffer.

fn try_generate_xid( &mut self, ctx: &mut Context<'_>, ) -> Result<AsyncStatus<u32>>

Generate a unique XID.

fn try_maximum_request_length( &mut self, ctx: &mut Context<'_>, ) -> Result<AsyncStatus<usize>>

Get the maximum length of a request that can be sent.

fn try_send_request_raw( &mut self, req: &mut RawRequest<'_, '_>, ctx: &mut Context<'_>, ) -> Result<AsyncStatus<()>>

Partially send the request.

fn try_wait_for_event( &mut self, ctx: &mut Context<'_>, ) -> Result<AsyncStatus<Event>>

Wait for an event.

fn try_wait_for_reply_raw( &mut self, seq: u64, ctx: &mut Context<'_>, ) -> Result<AsyncStatus<RawReply>>

Wait for the reply.

fn try_check_for_error( &mut self, seq: u64, ctx: &mut Context<'_>, ) -> Result<AsyncStatus<()>>

Try to check for an error.

impl<D: Display + ?Sized> Display for SpecialEventDisplay<D>

fn send_request_raw(&mut self, req: RawRequest<'_, '_>) -> Result<u64>

Send a raw request to the X11 server.

fn flush(&mut self) -> Result<()>

Flush all pending requests to the server.

fn generate_xid(&mut self) -> Result<u32>

Get a unique ID valid for use by the server.

fn maximum_request_length(&mut self) -> Result<usize>

Get the maximum request length that can be sent.

fn synchronize(&mut self) -> Result<()>

Synchronize this display with the server.

fn wait_for_reply_raw(&mut self, seq: u64) -> Result<RawReply>

Wait for a reply from the X11 server.

fn wait_for_event(&mut self) -> Result<Event>

Wait for an event.

fn check_for_error(&mut self, seq: u64) -> Result<()>

Check for an error for the given sequence number.

impl<D: DisplayBase + ?Sized> DisplayBase for SpecialEventDisplay<D>

fn setup(&self) -> &Arc<Setup>

Get the Setup associated with this display.

fn default_screen_index(&self) -> usize

Get the screen associated with this display.

fn poll_for_event(&mut self) -> Result<Option<Event>>

Poll to see if we have received an event.

fn poll_for_reply_raw(&mut self, seq: u64) -> Result<Option<RawReply>>

Poll to see if a reply matching the sequence number has been received.

fn screens(&self) -> &[Screen]

Get the screens for this display.

fn default_screen(&self) -> &Screen

Get the default screen for this display.

impl<Dpy> From<Dpy> for SpecialEventDisplay<Dpy>

fn from(display: Dpy) -> Self

Converts to this type from the input type.