Enum leptos::Attribute

pub enum Attribute {
    String(String),
    Fn(Scope, Rc<dyn Fn() -> Attribute + 'static>),
    Option(Scope, Option<String>),
    Bool(bool),
}

Represents the different possible values an attribute node could have.

This mostly exists for the view macro’s use. You usually won’t need to interact with it directly, but it can be useful for defining permissive APIs for certain components.

Variants

String(String)

A plain string value.

Fn(Scope, Rc<dyn Fn() -> Attribute + 'static>)

A (presumably reactive) function, which will be run inside an effect to do targeted updates to the attribute.

Option(Scope, Option<String>)

An optional string value, which sets the attribute to the value if Some and removes the attribute if None.

Bool(bool)

A boolean attribute, which sets the attribute if true and removes the attribute if false.

Implementations

impl Attribute

pub fn as_value_string(&self, attr_name: &'static str) -> String

Converts the attribute to its HTML value at that moment, including the attribute name, so it can be rendered on the server.

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

Converts the attribute to its HTML value at that moment, not including the attribute name, so it can be rendered on the server.

Trait Implementations

impl Clone for Attribute

fn clone(&self) -> Attribute

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Attribute

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

Formats the value using the given formatter.

impl IntoAttribute for Attribute

fn into_attribute(self, _: Scope) -> Attribute

Converts the object into an Attribute.

fn into_attribute_boxed(self: Box<Attribute, Global>, _: Scope) -> Attribute

Helper function for dealing with Box<dyn IntoAttribute>.

impl PartialEq<Attribute> for Attribute

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.