Enum Text 

pub enum Text<'a> {
    Sanitized(Cow<'a, str>),
    Trusted(Cow<'a, str>),
}

Text with trust level annotation.

Use this to explicitly mark whether text has been sanitized or comes from a trusted source.

Variants

Sanitized(Cow<'a, str>)

Sanitized text (escape sequences stripped).

Trusted(Cow<'a, str>)

Trusted text (may contain ANSI sequences). Only use with content from trusted sources.

Implementations

impl<'a> Text<'a>

pub fn sanitized(s: &'a str) -> Self

Create sanitized text from an untrusted source.

pub fn trusted(s: &'a str) -> Self

Create from a trusted source (ANSI sequences allowed).

Safety

Only use with content from trusted sources. Untrusted content can corrupt terminal state or deceive users.

pub fn sanitized_owned(s: String) -> Self

Create owned sanitized text.

pub fn trusted_owned(s: String) -> Self

Create owned trusted text.

pub fn as_str(&self) -> &str

Get the inner string slice.

pub fn is_sanitized(&self) -> bool

Check if this text is sanitized.

pub fn is_trusted(&self) -> bool

Check if this text is trusted.

pub fn into_owned(self) -> Text<'static>

Convert to owned version.

Trait Implementations

impl AsRef<str> for Text<'_>

fn as_ref(&self) -> &str

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

impl<'a> Clone for Text<'a>

fn clone(&self) -> Text<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Text<'a>

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

Formats the value using the given formatter.

impl Display for Text<'_>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Text<'a>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Eq for Text<'a>

impl<'a> StructuralPartialEq for Text<'a>