Struct kas_text::Text

pub struct Text<T: FormattableText> { /* fields omitted */ }

Text, prepared for display in a given enviroment

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: FormattableText> Text<T>

pub fn new(env: Environment, text: T) -> Self

Construct from an environment and a text model

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

pub fn new_single(text: T) -> Self

Construct from a default environment (single-line) and text

The environment is default-constructed, with line-wrapping turned off (see Environment::flags doc).

pub fn new_multi(text: T) -> Self

Construct from a default environment (multi-line) and text

The environment is default-constructed (line-wrap on).

pub fn clone_text(&self) -> T where
    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.

Trait Implementations

impl<T: FormattableText> AsMut<TextDisplay> for Text<T>

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

Performs the conversion.

impl<T: FormattableText> AsRef<TextDisplay> for Text<T>

fn as_ref(&self) -> &TextDisplay

Performs the conversion.

impl<T: Clone + FormattableText> Clone for Text<T>

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 + FormattableText> Debug for Text<T>

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

Formats the value using the given formatter.

impl<T: FormattableText + Default> Default for Text<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: EditableText> EditableTextApi for Text<T>

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: FormattableText> TextApi for Text<T>

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 env_mut(&mut self) -> &mut Environment

Mutate the environment

fn require_action(&mut self, action: Action)

Require an action

fn prepare(&mut self) -> Option<Vec2>

Prepare text for display

fn prepare_runs(&mut self)

Prepare text runs

fn resize_runs(&mut self)

Update font size

fn prepare_lines(&mut self) -> Vec2

Prepare lines (“wrap”)

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

Get the sequence of effect tokens

fn str_len(&self) -> usize

Length of text