Struct ExecuteScript

pub struct ExecuteScript {
    pub id: Option<String>,
    pub retry: Duration,
    pub script: String,
    pub auto_remove: bool,
    pub attributes: Vec<String>,
}

ExecuteScript executes JavaScript in the browser

See the Datastar documentation.

Examples

use datastar::prelude::{Sse, ExecuteScript};
use async_stream::stream;

Sse(stream! {
    yield ExecuteScript::new("console.log('Hello, world!')")
        .auto_remove(false)
        .attributes(["type text/javascript"]);
});

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

script: String

script is a string that represents the JavaScript to be executed by the browser.

auto_remove: bool

Whether to remove the script after execution, if not provided the Datastar client side will default to true.

attributes: Vec<String>

A list of attributes to add to the script element, if not provided the Datastar client side will default to type module. Each item in the array must be a string in the format key value.

Implementations

impl ExecuteScript

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

Creates a new ExecuteScript event with the given script.

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

Sets the id of the ExecuteScript event.

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

Sets the retry of the ExecuteScript event.

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

Sets the script of the ExecuteScript event.

pub fn attributes( self, attributes: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Sets the attribute of the ExecuteScript event.

pub fn into_event(self) -> DatastarEvent

Converts this ExecuteScript into a DatastarEvent.

Trait Implementations

impl Clone for ExecuteScript

fn clone(&self) -> ExecuteScript

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExecuteScript

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

Formats the value using the given formatter.

impl From<ExecuteScript> for DatastarEvent

fn from(val: ExecuteScript) -> Self

Converts to this type from the input type.

impl Hash for ExecuteScript

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 ExecuteScript

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

impl StructuralPartialEq for ExecuteScript