Struct kas::prelude::Text

pub struct Text<T>where
    T: FormattableText + ?Sized,{ /* private fields */ }

Text, prepared for display in a given environment

This struct is composed of three parts: an Environment, a representation of the FormattableText being displayed, and a TextDisplay object.

Most Functionality is implemented via the TextApi and TextApiExt traits.

Implementations

impl<T> Text<T>where
    T: FormattableText,

pub fn new(text: T) -> Text<T>

Construct from a text model

This struct must be made ready for usage by calling Text::prepare.

pub fn new_env(env: Environment, text: T) -> Text<T>

Construct from a text model and environment

This struct must be made ready for usage by calling Text::prepare.

pub fn clone_text(&self) -> Twhere
    T: Clone,

Clone the formatted text

pub fn take_text(self) -> T

Extract text object, discarding the rest

pub fn text(&self) -> &T

Access the formattable text object

pub fn set_text(&mut self, text: T)

Set the text

One must call Text::prepare afterwards and may wish to inspect its return value to check the size allocation meets requirements.

pub fn set_and_try_prepare(&mut self, text: T) -> Result<bool, InvalidFontId>

Set the text and prepare (if any fonts are loaded)

Sets text regardless of other outcomes.

If fonts are not loaded, this fails fast (see fonts::any_loaded), unlike other preparation methods.

Returns true if at least some action is performed and the text exceeds the allocated bounds (Environment::bounds).

Trait Implementations

impl<T> AsMut<TextDisplay> for Text<T>where
    T: FormattableText + ?Sized,

fn as_mut(&mut self) -> &mut TextDisplay

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T> AsRef<TextDisplay> for Text<T>where
    T: FormattableText + ?Sized,

fn as_ref(&self) -> &TextDisplay

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Clone for Text<T>where
    T: Clone + FormattableText + ?Sized,

fn clone(&self) -> Text<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Text<T>where
    T: Debug + FormattableText + ?Sized,

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

Formats the value using the given formatter.

impl<T> Default for Text<T>where
    T: Default + FormattableText + ?Sized,

fn default() -> Text<T>

Returns the “default value” for a type.

impl<T> EditableTextApi for Text<T>where
    T: EditableText + ?Sized,

fn insert_char(&mut self, index: usize, c: char)

Insert a char at the given position

fn replace_range(&mut self, range: Range<usize>, replace_with: &str)

Replace a section of text

fn set_string(&mut self, string: String)

Set text to a raw String

fn swap_string(&mut self, string: &mut String)

Swap the raw text with a String

impl<T> TextApi for Text<T>where
    T: FormattableText + ?Sized,

fn display(&self) -> &TextDisplay

Read the TextDisplay

fn as_str(&self) -> &str

Access whole text as contiguous str

fn clone_string(&self) -> String

Clone the unformatted text as a String

fn env(&self) -> Environment

Read the environment

fn set_env(&mut self, env: Environment)

Set the environment

fn require_action(&mut self, action: Action)

Require an action

fn prepare_runs(&mut self) -> Result<(), InvalidFontId>

Prepare text runs

fn measure_width(&mut self, limit: f32) -> Result<f32, InvalidFontId>

Measure required width, up to some limit

fn measure_height(&mut self) -> Result<f32, InvalidFontId>

Measure required vertical height, wrapping as configured

fn prepare(&mut self) -> Result<bool, InvalidFontId>

Prepare text for display, as necessary

fn effect_tokens(&self) -> &[Effect<()>]

Get the sequence of effect tokens

fn str_len(&self) -> usize

Length of text