Struct cursive::utils::span::SpannedString

pub struct SpannedString<T> { /* fields omitted */ }

A string with associated spans.

Each span has an associated attribute T.

Methods

impl SpannedString<Style>

pub fn plain<S>(content: S) -> Self where     S: Into<String>,

Returns a plain StyledString without any style.

You got no style, Dutch. You know that.

pub fn styled<S, T>(content: S, style: T) -> Self where     S: Into<String>,     T: Into<Style>,

Creates a new StyledString using a single style for the entire text.

pub fn append_plain<S>(&mut self, text: S) where     S: Into<String>,

Appends the given plain text to self.

pub fn append_styled<S, T>(&mut self, text: S, style: T) where     S: Into<String>,     T: Into<Style>,

Appends text to self, using style.

impl SpannedString<()>

pub fn plain<S>(content: S) -> Self where     S: Into<String>,

Returns a simple spanned string without any attribute.

impl<T> SpannedString<T>

pub fn new() -> Self

Returns an empty SpannedString.

pub fn with_spans<S>(source: S, spans: Vec<IndexedSpan<T>>) -> Self where     S: Into<String>,

Creates a new SpannedString manually.

It is not recommended to use this directly. Instead, look for methods like Markdown::parse.

pub fn single_span<S>(source: S, attr: T) -> Self where     S: Into<String>,

Returns a new SpannedString with a single span.

pub fn append<S>(&mut self, other: S) where     S: Into<Self>,

Appends the given StyledString to self.

pub fn append_raw(&mut self, source: &str, spans: Vec<IndexedSpan<T>>)

Appends content and its corresponding spans to the end.

It is not recommended to use this directly; instead, look at the append method.

Important traits for Vec<u8>

impl Write for Vec<u8>

pub fn spans<'a>(&'a self) -> Vec<Span<'a, T>>

Gives access to the parsed styled spans.

Important traits for &'a [u8]

impl<'a> Read for &'a [u8]impl<'a> Write for &'a mut [u8]

pub fn spans_raw(&self) -> &[IndexedSpan<T>]

Returns a reference to the indexed spans.

pub fn source(&self) -> &str

Returns a reference to the source string.

This is the non-parsed string.

pub fn is_empty(&self) -> bool

Returns true if self is empty.

Trait Implementations

impl<T: Debug> Debug for SpannedString<T>

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

Formats the value using the given formatter.

impl<T: Clone> Clone for SpannedString<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: PartialEq> PartialEq for SpannedString<T>

fn eq(&self, other: &SpannedString<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SpannedString<T>) -> bool

This method tests for !=.

impl<T: Eq> Eq for SpannedString<T>

impl<T> Default for SpannedString<T>

fn default() -> Self

Returns the "default value" for a type.

impl<'a, T> SpannedText for &'a SpannedString<T>

type S = IndexedSpan<T>

Type of span returned by SpannedText::spans().

fn source(&self) -> &str

Returns the source text.

Important traits for &'a [u8]

impl<'a> Read for &'a [u8]impl<'a> Write for &'a mut [u8]

fn spans(&self) -> &[IndexedSpan<T>]

Returns the spans for this text.

fn as_ref<'a>(&'a self) -> SpannedTextRef<'a, Self>

Returns a SpannedText by reference.

impl<S, T> From<S> for SpannedString<T> where     S: Into<String>,     T: Default,

fn from(value: S) -> Self

Performs the conversion.

impl<'a, T> From<&'a SpannedString<T>> for SpannedStr<'a, T>

fn from(other: &'a SpannedString<T>) -> Self

Performs the conversion.