Struct Text 

pub struct Text { /* private fields */ }

Styled text of any length: a paragraph, a table cell, a title.

Text from outside the program is safe to put here. Every character that is_unsafe refuses is removed, except newline and tab.

Every other line break becomes a newline: carriage return, vertical tab, form feed, next line, and the line and paragraph separators. A carriage return before a line feed is one break with it. A newline starts a new line. A tab expands to the next tab stop of the Context it is rendered in, counted from the start of its line.

Two texts are equal when their content, styles, and Overflow are. Empty pieces are dropped and neighbours in one style are joined, however the text was pushed.

Text is Renderable: Overflow decides how it fits a width.

Implementations

impl Text

pub fn new() -> Text

Text with nothing in it. It renders to no lines.

pub fn plain(text: impl AsRef<str>) -> Text

text in the default style.

pub fn styled(text: impl AsRef<str>, style: Style) -> Text

text in style.

pub fn push(&mut self, text: impl AsRef<str>, style: Style)

Adds text in style after what is already there. A newline in text starts a new line.

pub fn overflow(self, overflow: Overflow) -> Text

Sets what to do with a line wider than the width it renders at. The default is Overflow::KeepWords.

pub fn lines(&self, tab_width: NonZero<u16>) -> Vec<Line>

The text as lines, with tabs expanded to multiples of tab_width.

Nothing is wrapped. A text that ends in a newline ends in an empty line.

impl Text

pub fn measure_as(&self, context: &Context, overflow: Overflow) -> Measurement

measure as if the text’s overflow were overflow, so a container that decides overflow per column measures a table cell without cloning it.

pub fn render_as(&self, context: &Context, overflow: Overflow) -> Vec<Line>

render as if the text’s overflow were overflow, so a container that decides overflow per column renders a table cell without cloning it.

Trait Implementations

impl Clone for Text

fn clone(&self) -> Text

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Text

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

Formats the value using the given formatter.

impl Default for Text

fn default() -> Text

Returns the “default value” for a type.

impl Eq for Text

impl From<&str> for Text

fn from(text: &str) -> Text

Converts to this type from the input type.

impl From<Span> for Text

fn from(span: Span) -> Text

Converts to this type from the input type.

impl From<String> for Text

fn from(text: String) -> Text

Converts to this type from the input type.

impl Hash for Text

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Text

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

Equality operator ==.

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

Inequality operator !=.

impl Renderable for Text

fn measure(&self, context: &Context) -> Measurement

The narrowest and widest this content can usefully be.

fn render(&self, context: &Context) -> Vec<Line>

Lines no wider than context.width(), except a word or cluster that the content’s overflow policy keeps whole.

impl StructuralPartialEq for Text