Struct biodivine_sketchbook::app::event::Event

pub struct Event {
    pub path: Vec<String>,
    pub payload: Option<String>,
}

An Event object holds information about one particular state update.

It consists of a segmented path and an optional payload. The payload is expected to be a JSON-encoded value.

Multiple events can be combined together to create one UserAction or StateChange. The purpose of this mechanism is to indicate that these events should be handled together, as if they represented a single UI operations (e.g. they should only hold one undo stack entry).

Fields

path: Vec<String>

payload: Option<String>

Implementations

impl Event

pub fn build(path: &[&str], payload: Option<&str>) -> Event

pub fn byte_size(&self) -> usize

An estimated amount of bytes consumed by the data stored in this Event.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Event

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Event> for StateChange

fn from(value: Event) -> Self

Converts to this type from the input type.

impl From<Event> for UserAction

fn from(value: Event) -> Self

Converts to this type from the input type.

impl PartialEq for Event

fn eq(&self, other: &Event) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Event

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Event

impl StructuralPartialEq for Event