Struct PatchSignals

pub struct PatchSignals<T = String> {
    pub signals: T,
    pub only_if_missing: bool,
}

PatchSignals patches signals into the signal store

Fields

signals: T

signals is a JavaScript object or JSON string that will be sent to the browser to update signals in the signals.

The data must evaluate to a valid JavaScript. It will be converted to signals by the Datastar client side.

only_if_missing: bool

Whether to merge the signal only if it does not already exist.

If not provided, the Datastar client side will default to false, which will cause the data to be merged into the signals.

Implementations

impl<T> PatchSignals<T>

pub const TYPE: EventType = EventType::PatchSignals

pub fn new(signals: T) -> PatchSignals<T>

Create a new PatchSignals data blob.

pub fn into_sse_event(self) -> Event<PatchSignals<T>>

Consume self as an Event.

pub fn into_datastar_event(self) -> Event<EventData<T>>

Consume self as a super::DatastarEvent.

pub fn with_only_if_missing(self, only_if_missing: bool) -> PatchSignals<T>

Sets whether to merge the signal only if it does not already exist.

pub fn set_only_if_missing( &mut self, only_if_missing: bool, ) -> &mut PatchSignals<T>

Sets whether to merge the signal only if it does not already exist.

Trait Implementations

impl<T> Clone for PatchSignals<T>

where T: Clone,

fn clone(&self) -> PatchSignals<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for PatchSignals<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> EventDataRead for PatchSignals<T>

where T: EventDataRead,

type Reader = PatchSignalsReader<<T as EventDataRead>::Reader>

fn line_reader() -> <PatchSignals<T> as EventDataRead>::Reader

impl<T> EventDataWrite for PatchSignals<T>

where T: EventDataWrite,

fn write_data(&self, w: &mut impl Write) -> Result<(), OpaqueError>

impl<T> From<PatchSignals<T>> for Event<EventData<T>>

fn from(value: PatchSignals<T>) -> Event<EventData<T>>

Converts to this type from the input type.

impl<T> From<PatchSignals<T>> for Event<PatchSignals<T>>

fn from(value: PatchSignals<T>) -> Event<PatchSignals<T>>

Converts to this type from the input type.

impl<T> From<PatchSignals<T>> for EventData<T>

fn from(value: PatchSignals<T>) -> EventData<T>

Converts to this type from the input type.

impl<T> Hash for PatchSignals<T>

where T: Hash,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> PartialEq for PatchSignals<T>

where T: PartialEq,

fn eq(&self, other: &PatchSignals<T>) -> 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<T> Eq for PatchSignals<T>

where T: Eq,

impl<T> StructuralPartialEq for PatchSignals<T>