Struct Text 

pub struct Text { /* private fields */ }

Available on crate feature document only.

Text made of Spans, each carrying a Role.

A &str or String converts into plain text, so most methods that take impl Into<Text> accept either.

use ctl_core::document::{Role, Text};

let text = Text::new().token("--force").then(" overwrites ").id("A-1");
assert_eq!(text.spans().len(), 3);
assert_eq!(text.spans()[0].role(), Role::Token);

Implementations

impl Text

pub const fn new() -> Self

Start text with no spans.

pub fn plain(value: impl Into<String>) -> Self

Start text with one Role::Plain span holding value.

pub fn span(self, role: Role, value: impl Into<String>) -> Self

Append a span holding value in role.

pub fn then(self, value: impl Into<String>) -> Self

Append value in Role::Plain. A chain of then and role methods reads left to right.

pub fn token(self, value: impl Into<String>) -> Self

Append value in Role::Token: a flag, command, or field name.

pub fn id(self, value: impl Into<String>) -> Self

Append value in Role::Id: the id of a row, patch, or package.

pub fn value(self, value: impl Into<String>) -> Self

Append value in Role::Value: a value or a metavar.

pub fn muted(self, value: impl Into<String>) -> Self

Append value in Role::Muted: secondary information.

pub fn success(self, value: impl Into<String>) -> Self

Append value in Role::Success.

pub fn warning(self, value: impl Into<String>) -> Self

Append value in Role::Warning.

pub fn error(self, value: impl Into<String>) -> Self

Append value in Role::Error.

pub fn spans(&self) -> &[Span]

The spans, in the order they were appended.

pub fn is_empty(&self) -> bool

Whether every span is empty, or there are none. A span of spaces is not empty.

Trait Implementations

impl Clone for Text

fn clone(&self) -> Self

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

Formats the value using the given formatter.

impl Default for Text

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Text

impl From<&str> for Text

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for Text

fn from(value: String) -> Self

Converts to this type from the input type.

impl PartialEq for Text

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Text