Enum ActionInput 

pub enum ActionInput {
    None,
    EffectOk {
        req_id: u64,
        payload: EffectPayload,
    },
    EffectErr {
        req_id: u64,
        message: String,
    },
    Pointer {
        x: f32,
        y: f32,
        delta_x: f32,
        delta_y: f32,
    },
    Drop {
        paths: Vec<String>,
        x: f32,
        y: f32,
    },
    InternalDrop {
        payload: Vec<u8>,
        x: f32,
        y: f32,
    },
}

Extra input data passed alongside an action dispatch.

When the platform delivers an effect result or a drag-and-drop event, it attaches an ActionInput so the reducer can access the associated data without encoding it in the action payload.

Example

fn on_file_loaded(
    state: &mut MyState,
    _action: FileLoaded,
    ctx: &mut ReducerContext<MyState>,
) {
    if let Some(bytes) = ctx.input.as_bytes() {
        state.file_contents = String::from_utf8_lossy(bytes).into_owned();
    }
}

Variants

None

No extra input.

EffectOk

The effect completed successfully.

Fields

req_id: u64

payload: EffectPayload

EffectErr

The effect failed with an error message.

Fields

req_id: u64

message: String

Pointer

Pointer coordinates and deltas (used by drag/gesture handlers).

Fields

x: f32

y: f32

delta_x: f32

delta_y: f32

Drop

External file drop (e.g. from the OS file manager).

Fields

paths: Vec<String>

x: f32

y: f32

InternalDrop

Internal drag-and-drop with an opaque byte payload.

Fields

payload: Vec<u8>

x: f32

y: f32

Implementations

impl ActionInput

pub fn as_bytes(&self) -> Option<&[u8]>

pub fn as_pointer(&self) -> Option<(f32, f32, f32, f32)>

pub fn as_drop_paths(&self) -> Option<&[String]>

pub fn as_internal_drop(&self) -> Option<&[u8]>

Trait Implementations

impl Clone for ActionInput

fn clone(&self) -> ActionInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ActionInput

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

Formats the value using the given formatter.

impl PartialEq for ActionInput

fn eq(&self, other: &ActionInput) -> 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 StructuralPartialEq for ActionInput