Struct ExecuteScript

pub struct ExecuteScript {
    pub script: Cow<'static, str>,
    pub auto_remove: Option<bool>,
    pub attributes: Option<Vec<ScriptAttribute>>,
}

ExecuteScript executes JavaScript in the browser

See the Datastar documentation.

Fields

script: Cow<'static, str>

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

auto_remove: Option<bool>

Whether to remove the script after execution.

If not provided the Datastar client side will default to true.

attributes: Option<Vec<ScriptAttribute>>

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, boolean value used in cased of boolean attributes.

Implementations

impl ExecuteScript

pub const TYPE: EventType = EventType::PatchElements

pub fn new(script: impl Into<Cow<'static, str>>) -> ExecuteScript

Create a new ExecuteScript data blob.

pub fn into_sse_event(self) -> Event<ExecuteScript>

Consume self as an Event.

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

Consume self as a super::DatastarEvent.

pub fn with_auto_remove(self, auto_remove: bool) -> ExecuteScript

Set whether to remove the script after execution.

pub fn set_auto_remove(&mut self, auto_remove: bool) -> &mut ExecuteScript

Set whether to remove the script after execution.

pub fn with_attribute(self, attribute: ScriptAttribute) -> ExecuteScript

Set a single attribute to add to the script element.

This overwrites any previously added script attribute.

pub fn set_attribute( &mut self, attribute: ScriptAttribute, ) -> &mut ExecuteScript

Set a single attribute to add to the script element.

This overwrites any previously added script attribute.

pub fn with_attributes( self, attributes: impl IntoIterator<Item = ScriptAttribute>, ) -> ExecuteScript

Set a list of attributes to add to the script element.

pub fn set_attributes( &mut self, attributes: impl IntoIterator<Item = ScriptAttribute>, ) -> &mut ExecuteScript

Set a list of attributes to add to the script element.

pub fn with_additional_attribute( self, attribute: ScriptAttribute, ) -> ExecuteScript

Add an additional attribute

pub fn set_additional_attribute( &mut self, attribute: ScriptAttribute, ) -> &mut ExecuteScript

Add an additional attribute

pub fn with_additional_attributes( self, attributes: impl IntoIterator<Item = ScriptAttribute>, ) -> ExecuteScript

Set a list of attributes to add to the script element.

pub fn set_additional_attributes( &mut self, attributes: impl IntoIterator<Item = ScriptAttribute>, ) -> &mut ExecuteScript

Set a list of attributes to add to the script element.

Trait Implementations

impl Clone for ExecuteScript

fn clone(&self) -> ExecuteScript

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl EventDataWrite for ExecuteScript

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

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

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

Converts to this type from the input type.

impl From<ExecuteScript> for Event<ExecuteScript>

fn from(value: ExecuteScript) -> Event<ExecuteScript>

Converts to this type from the input type.

impl<T> From<ExecuteScript> for EventData<T>

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

Converts to this type from the input type.

impl Hash for ExecuteScript

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 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