Struct Class

pub struct Class(/* private fields */);

Sets the entities class to be matched by selectors in oncss.

The behavior mimics CSS so a single class name can given or a list separated by spaces.

Examples

fn system(mut commands: Commands) {
    // This entity can be selected by either ".yellow-button", ".enabled"
    // or even ".yellow-button.enabled"
    commands.spawn(Class::new("yellow-button enabled"));
}

Implementations

impl Class

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

Creates a new Class with the given class names.

Multiple class names can be used separated by spaces.

pub fn add(&mut self, class: &str) -> bool

Appends a new class name to this component. If the class name is already present, it will be ignored.

Note that modifying a class will not automatically trigger the style system to reapply the style sheet. If you want to reapply the style sheet, you must manually use the StyleSheet::refresh method.

This method returns true if the class was modified, false otherwise. You can use this to check if the style sheet needs to be refreshed.

pub fn remove(&mut self, class: &str) -> bool

Removes a class name from this component. If the class name is not present, it will be ignored.

Note that modifying a class will not automatically trigger the style system to reapply the style sheet. If you want to reapply the style sheet, you must manually use the StyleSheet::refresh method.

This method returns true if the class was modified, false otherwise. You can use this to check if the style sheet needs to be refreshed.

pub fn set(&mut self, class: impl Into<Cow<'static, str>>) -> bool

Replaces all class names with the given one as if a new Class component was created.

Note that modifying a class will not automatically trigger the style system to reapply the style sheet. If you want to reapply the style sheet, you must manually use the StyleSheet::refresh method.

This method returns true if the class was modified, false otherwise. You can use this to check if the style sheet needs to be refreshed.

Methods from Deref<Target = Cow<'static, str>>

pub fn is_borrowed(&self) -> bool

🔬This is a nightly-only experimental API. (cow_is_borrowed)

Returns true if the data is borrowed, i.e. if to_mut would require additional work.

Examples

#![feature(cow_is_borrowed)]
use std::borrow::Cow;

let cow = Cow::Borrowed("moo");
assert!(cow.is_borrowed());

let bull: Cow<'_, str> = Cow::Owned("...moo?".to_string());
assert!(!bull.is_borrowed());

pub fn is_owned(&self) -> bool

🔬This is a nightly-only experimental API. (cow_is_borrowed)

Returns true if the data is owned, i.e. if to_mut would be a no-op.

Examples

#![feature(cow_is_borrowed)]
use std::borrow::Cow;

let cow: Cow<'_, str> = Cow::Owned("moo".to_string());
assert!(cow.is_owned());

let bull = Cow::Borrowed("...moo?");
assert!(!bull.is_owned());

Trait Implementations

impl Clone for Class

fn clone(&self) -> Class

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for Class

where Self: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either TableStorage or SparseStorage.

impl Debug for Class

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

Formats the value using the given formatter.

impl Default for Class

fn default() -> Class

Returns the “default value” for a type.

impl Deref for Class

type Target = Cow<'static, str>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl FromReflect for Class

where Self: Any + Send + Sync, Cow<'static, str>: FromReflect + TypePath,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect>, ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for Class

where Self: Any + Send + Sync, Cow<'static, str>: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Reflect for Class

where Self: Any + Send + Sync, Cow<'static, str>: FromReflect + TypePath,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn apply(&mut self, value: &dyn Reflect)

Applies a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl TupleStruct for Class

where Self: Any + Send + Sync, Cow<'static, str>: FromReflect + TypePath,

fn field(&self, index: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn field_len(&self) -> usize

Returns the number of fields in the tuple struct.

fn iter_fields(&self) -> TupleStructFieldIter<'_>

Returns an iterator over the values of the tuple struct’s fields.

fn clone_dynamic(&self) -> DynamicTupleStruct

Clones the struct into a DynamicTupleStruct.

impl TypePath for Class

where Self: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for Class

where Self: Any + Send + Sync, Cow<'static, str>: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.