Skip to main content

Event

Struct Event 

Source
pub struct Event<T> { /* private fields */ }
Expand description

A stream of discrete occurrences

Event<T> allows you to react to discrete happenings like clicks, keypresses, or timer ticks. Events can be mapped, filtered, and merged with other events.

§Example

use cliffy_core::{event, Event};

let clicks = event::<()>();

clicks.subscribe(|_| {
    println!("Clicked!");
});

clicks.emit(());

Implementations§

Source§

impl<T: Clone + 'static> Event<T>

Source

pub fn new() -> Self

Create a new event stream

Source

pub fn emit(&self, value: T)

Emit a value to all subscribers

Source

pub fn subscribe<F>(&self, callback: F) -> EventSubscription
where F: Fn(&T) + 'static,

Subscribe to this event stream

Source

pub fn map<U, F>(&self, f: F) -> Event<U>
where U: Clone + 'static, F: Fn(T) -> U + 'static,

Map a function over this event stream

Source

pub fn filter<F>(&self, predicate: F) -> Event<T>
where F: Fn(&T) -> bool + 'static,

Filter events based on a predicate

Source

pub fn merge(&self, other: &Event<T>) -> Event<T>

Merge two event streams

Source

pub fn fold<S, F>(&self, initial: S, f: F) -> Behavior<S>
where S: IntoGeometric + FromGeometric + Clone + 'static, F: Fn(S, T) -> S + 'static,

Fold events into a behavior, accumulating values

Trait Implementations§

Source§

impl<T> Clone for Event<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<T: Clone + 'static> Default for Event<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Event<T>

§

impl<T> !RefUnwindSafe for Event<T>

§

impl<T> !Send for Event<T>

§

impl<T> !Sync for Event<T>

§

impl<T> Unpin for Event<T>

§

impl<T> UnsafeUnpin for Event<T>

§

impl<T> !UnwindSafe for Event<T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.