Struct Component 

pub struct Component { /* private fields */ }

The Text Component simply visualizes any given text. This can either be a single centered text, or split up into a left and right text, which is suitable for a situation where you have a label and a value.

Implementations

impl Component

pub fn new() -> Self

Creates a new Text Component.

pub const fn with_settings(settings: Settings) -> Self

Creates a new Text Component with the given settings.

pub const fn settings(&self) -> &Settings

Accesses the settings of the component.

pub fn settings_mut(&mut self) -> &mut Settings

Grants mutable access to the settings of the component.

pub fn name(&self) -> Cow<'_, str>

Accesses the name of the component.

pub fn update_state(&self, state: &mut State, timer: &Timer)

Updates the component’s state based on the timer provided.

pub fn state(&self, timer: &Timer) -> State

Calculates the component’s state.

pub fn settings_description(&self) -> SettingsDescription

Accesses a generic description of the settings available for this component and their current values.

pub fn set_value(&mut self, index: usize, value: Value)

Sets a setting’s value by its index to the given value.

Panics

This panics if the type of the value to be set is not compatible with the type of the setting’s value. A panic can also occur if the index of the setting provided is out of bounds.

Trait Implementations

impl Clone for Component

fn clone(&self) -> Component

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Component

fn default() -> Component

Returns the “default value” for a type.

impl From<Component> for Component

fn from(component: Component) -> Self

Converts to this type from the input type.