Struct PatchSignals 

pub struct PatchSignals {
    pub id: Option<String>,
    pub retry: Duration,
    pub signals: String,
    pub only_if_missing: bool,
}

PatchSignals patches signals into the signal store.

Fields

id: Option<String>

id can be used by the backend to replay events. This is part of the SSE spec and is used to tell the browser how to handle the event. For more details see https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#id

retry: Duration

retry is part of the SSE spec and is used to tell the browser how long to wait before reconnecting if the connection is lost. For more details see https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#retry

signals: String

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 patch 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 patched into the signals.

Implementations

impl PatchSignals

pub fn write_as_axum_sse_event(&self) -> Event

Write this PatchSignals into an Axum SSE Event.

impl PatchSignals

pub fn write_as_rocket_sse_event(&self) -> Event

Write this PatchSignals into a Rocket SSE Event.

impl PatchSignals

pub fn new(signals: impl Into<String>) -> Self

Creates a new PatchSignals event with the given signals.

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

Sets the id of the PatchSignals event.

pub fn retry(self, retry: Duration) -> Self

Sets the retry of the PatchSignals event.

pub fn only_if_missing(self, only_if_missing: bool) -> Self

Sets the only_if_missing of the PatchSignals event.

pub fn into_datastar_event(self) -> DatastarEvent

Converts this PatchSignals into a DatastarEvent.

pub fn as_datastar_event(&self) -> DatastarEvent

Copy this PatchSignals as a DatastarEvent.

Trait Implementations

impl Clone for PatchSignals

fn clone(&self) -> PatchSignals

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PatchSignals

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

Formats the value using the given formatter.

impl From<&PatchSignals> for DatastarEvent

fn from(val: &PatchSignals) -> Self

Converts to this type from the input type.

impl From<&PatchSignals> for Event

fn from(value: &PatchSignals) -> Self

Converts to this type from the input type.

impl From<&PatchSignals> for Event

fn from(value: &PatchSignals) -> Self

Converts to this type from the input type.

impl From<PatchSignals> for DatastarEvent

fn from(val: PatchSignals) -> Self

Converts to this type from the input type.

impl From<PatchSignals> for Event

fn from(value: PatchSignals) -> Self

Converts to this type from the input type.

impl From<PatchSignals> for Event

fn from(value: PatchSignals) -> Self

Converts to this type from the input type.

impl Hash for PatchSignals

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

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 PartialEq for PatchSignals

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

impl StructuralPartialEq for PatchSignals