Skip to main content
This is unreleased documentation for Yew Next version.
For up-to-date documentation, see the latest version on docs.rs.

Attributes

Enum Attributes 

Source
#[non_exhaustive]
pub enum Attributes { }
Expand description

A collection of attributes for an element

Implementations§

Source§

impl Attributes

Source

pub fn from_static( statics: &'static [(&'static str, AttributeOrProperty)], ) -> Self

Static list of attributes.

Allows optimizing comparison to a simple pointer equality check and reducing allocations, if the attributes do not change on a node.

Source

pub fn from_static_unchecked( statics: &'static [(&'static str, AttributeOrProperty)], ) -> Self

Same as Self::from_static but without verifying keys. This can lead to loss of validity of an SSR document!

Source

pub fn from_dynamic_values( keys: &'static [&'static str], values: Box<[Option<AttributeOrProperty>]>, ) -> Self

Static list of attribute keys with possibility to exclude attributes and dynamic attribute values.

Allows optimizing comparison to a simple pointer equality check and reducing allocations, if the attributes keys do not change on a node.

Source

pub fn from_dynamic_values_unchecked( keys: &'static [&'static str], values: Box<[Option<AttributeOrProperty>]>, ) -> Self

Same as Self::from_dynamic_values but without verifying keys. This can lead to loss of validity of an SSR document!

Source

pub fn from_index_map(map: Rc<IndexMap<AttrValue, AttributeOrProperty>>) -> Self

IndexMap is used to provide runtime attribute deduplication in cases where the html! macro was not used to guarantee it.

Source

pub fn from_index_map_unchecked( map: Rc<IndexMap<AttrValue, AttributeOrProperty>>, ) -> Self

Same as Self::from_index_map but without verifying keys. This can lead to loss of validity of an SSR document!

Source

pub fn is_valid_attr_key(name: &str) -> bool

Validate a single attribute name for validity to be used as a key for an attribute or property. All keys must be valid according to this method when constructing Attributes. Usually, this is ensured by the usage context.

Specifically, this checks that the passed string is a valid XHTML attribute name. This implies that it consists of at least one character, does not contain whitespace or other special characters.

Source

pub fn new() -> Self

Construct a default Attributes instance

Source

pub fn iter<'a>(&'a self) -> Box<dyn Iterator<Item = (&'a str, &'a str)> + 'a>

Return iterator over attribute key-value pairs. This function is suboptimal and does not inline well. Avoid on hot paths.

This function only returns attributes

Source

pub fn get_mut_index_map_unchecked( &mut self, ) -> &mut IndexMap<AttrValue, AttributeOrProperty>

Get a mutable reference to the underlying IndexMap. If the attributes are stored in the Vec variant, it will be converted. The caller is responsible to check that inserted attribute names are valid, see Self::is_valid_attr_key

Trait Implementations§

Source§

impl Clone for Attributes

Source§

fn clone(&self) -> Attributes

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Attributes

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Attributes

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl From<IndexMap<&'static str, IString>> for Attributes

Source§

fn from(v: IndexMap<&'static str, AttrValue>) -> Self

Converts to this type from the input type.
Source§

impl From<IndexMap<&'static str, JsValue>> for Attributes

Source§

fn from(v: IndexMap<&'static str, JsValue>) -> Self

Converts to this type from the input type.
Source§

impl From<IndexMap<IString, IString>> for Attributes

Source§

fn from(map: IndexMap<AttrValue, AttrValue>) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Attributes

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Attributes

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoPropValue<Option<T>> for T

Source§

fn into_prop_value(self) -> Option<T>

Convert self to a value of a Properties struct.
Source§

impl<T> IntoPropValue<T> for T

Source§

fn into_prop_value(self) -> T

Convert self to a value of a Properties struct.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<Token, Builder, How> AllPropsFor<Builder, How> for Token
where Builder: Buildable<Token>, <Builder as Buildable<Token>>::WrappedToken: HasAllProps<<Builder as Buildable<Token>>::Output, How>,

Source§

impl<T> HasAllProps<(), T> for T