Struct UserEvent 

#[non_exhaustive]
pub struct UserEvent {
    pub kind: u32,
    pub int_data: i64,
    pub string_data: Option<String>,
}

Generic user event carried by Observer::on_send_event.

Construction

Use UserEvent::new to create a value; struct literal syntax is not available from outside this crate because UserEvent is #[non_exhaustive].

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

kind: u32

User-defined event kind.

int_data: i64

Numeric payload.

string_data: Option<String>

Optional string payload.

Implementations

impl UserEvent

pub const fn new(kind: u32, int_data: i64) -> Self

Create a new event with the given kind and int_data.

pub fn with_string(self, s: impl Into<String>) -> Self

Attach an optional string payload to this event.

Trait Implementations

impl Clone for UserEvent

fn clone(&self) -> UserEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserEvent

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

Formats the value using the given formatter.

impl Default for UserEvent

fn default() -> UserEvent

Returns the “default value” for a type.