Struct EventStream

pub struct EventStream { /* private fields */ }

Event listener, but [Stream] This is the new prefered way of listening for events as its more idiomatic, and allows for more efficient memory management

Examples

use hyprland::prelude::*;
use hyprland::event_listener::EventStream;
use hyprland::Result as HResult;
use futures_lite::StreamExt;

#[tokio::main]
async fn main() -> HResult<()> {
    let mut stream = EventStream::new();
    while let Some(Ok(event)) = stream.next().await {
         println!("{event:?}");
    }
}

Implementations

impl EventStream

pub fn new() -> EventStream

Creates a new EventStream

Trait Implementations

impl Stream for EventStream

type Item = Result<Event, HyprError>

Values yielded by the stream.

fn poll_next( self: Pin<&mut EventStream>, cx: &mut Context<'_>, ) -> Poll<Option<<EventStream as Stream>::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.