Struct BeforeInputData 

pub struct BeforeInputData { /* private fields */ }

Data fired alongside the beforeinput event.

The beforeinput event fires before an editable element (an <input>, <textarea>, or any element with contenteditable="true") is about to be modified. It exposes the kind of mutation that is about to happen via BeforeInputData::input_type and the text that is about to be inserted (if any) via BeforeInputData::data.

Unlike input, beforeinput is cancellable: calling event.prevent_default() from the handler will block the user-agent from applying the change.

See https://developer.mozilla.org/en-US/docs/Web/API/Element/beforeinput_event for the underlying DOM event.

Implementations

impl BeforeInputData

pub fn new(inner: impl HasBeforeInputData + 'static) -> Self

Create a new BeforeInputData from any HasBeforeInputData implementation.

pub fn input_type(&self) -> InputType

The type of change that is about to be applied to the editable element.

Returns an InputType so the common cases (e.g. InputType::InsertText, InputType::DeleteContentBackward) can be matched on directly. Values not covered by a known variant are preserved in InputType::Unknown. The full list is documented at https://w3c.github.io/input-events/#interface-InputEvent-Attributes.

pub fn data(&self) -> Option<String>

The characters that are about to be inserted by the user agent, if any.

None is returned for input types that don’t carry text data, e.g. deletions or rich-text formatting changes.

pub fn is_composing(&self) -> bool

Whether the event was fired while an IME composition session is active.

pub fn value(&self) -> String

The current value of the editable element, prior to the pending change.

pub fn downcast<T: 'static>(&self) -> Option<&T>

Downcast this event to a concrete platform-specific event type.

Trait Implementations

impl Debug for BeforeInputData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BeforeInputData

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl From<&BeforeInputData> for SerializedBeforeInputData

fn from(data: &BeforeInputData) -> Self

Converts to this type from the input type.

impl From<&PlatformEventData> for BeforeInputData

fn from(val: &PlatformEventData) -> Self

Converts to this type from the input type.

impl<E: HasBeforeInputData> From<E> for BeforeInputData

fn from(e: E) -> Self

Converts to this type from the input type.

impl PartialEq for BeforeInputData

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for BeforeInputData

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.