Struct cursive::utils::span::SpannedString

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

A string with associated spans.

Each span has an associated attribute T.

Implementations

impl SpannedString<Style>

pub fn plain<S>(content: S) -> SpannedString<Style>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) -> SpannedString<Style>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) -> SpannedString<()>where
    S: Into<String>,

Returns a simple spanned string without any attribute.

impl<T> SpannedString<T>

pub fn new() -> SpannedString<T>

Returns an empty SpannedString.

pub fn with_spans<S>(
    source: S,
    spans: Vec<IndexedSpan<T>, Global>
) -> SpannedString<T>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 compact(&mut self)

Compacts the source to only include the spans content.

pub fn trim_end(&mut self)

Shrink the source to discard any unused suffix.

pub fn trim_start(&mut self)

Shrink the source to discard any unused prefix.

pub fn trim(&mut self)

Shrink the source to discard any unused prefix or suffix.

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

Returns a new SpannedString with a single span.

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

Appends the given StyledString to self.

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

Appends content and its corresponding spans to the end.

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

pub fn remove_spans<R>(&mut self, range: R)where
    R: RangeBounds<usize>,

Remove the given range of spans from the styled string.

You may want to follow this with either compact(), trim_start() or trim_end().

pub fn spans(&self) -> impl DoubleEndedIterator + ExactSizeIterator

Iterates on the resolved spans.

pub fn spans_attr_mut(&mut self) -> impl Iterator<Item = SpanMut<'_, T>>

Iterates on the resolved spans, with mutable access to the attributes.

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

Returns a reference to the indexed spans.

pub fn spans_raw_attr_mut(
    &mut self
) -> impl DoubleEndedIterator + ExactSizeIterator

Returns a mutable iterator on the spans of this string.

This can be used to modify the style of each span.

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.

pub fn width(&self) -> usize

Returns the width taken by this string.

This is the sum of the width of each span.

Trait Implementations

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

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> Debug for SpannedString<T>where
    T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for SpannedString<T>

fn default() -> SpannedString<T>

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

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

fn from(value: S) -> SpannedString<T>

Converts to this type from the input type.

impl<T> FromIterator<SpannedString<T>> for SpannedString<T>

fn from_iter<I>(iter: I) -> SpannedString<T>where
    I: IntoIterator<Item = SpannedString<T>>,

Creates a value from an iterator.

impl<T> Hash for SpannedString<T>where
    T: Hash,

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,

Feeds a slice of this type into the given Hasher.

impl<T> PartialEq<SpannedString<T>> for SpannedString<T>where
    T: PartialEq<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: &Rhs) -> bool

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

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.

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

Returns the spans for this text.

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

Returns a SpannedText by reference.

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

impl<T> StructuralEq for SpannedString<T>

impl<T> StructuralPartialEq for SpannedString<T>