Struct RichString 

pub struct RichString {
    pub elements: Vec<Element>,
}

A string that can have different parts styled.

New lines will always appear as their own non styled element. The RichString is comprised of a collection of Elements that each hold a String and a combination of stylings. The available styles are:

• **bold** → bold
• *italic* → italic
• _underline_ → underline

as specified in the Fountain specification. Emphasis is parsed in accordance to the CommonMark specification. Furthermore, these can be combined in any overlapping order. Use \ for a styling character to be ignored for style parsing.

Examples

use rustwell::rich_string::RichString;

let mut rs = RichString::from("Hello **world!**");

assert_eq!(rs.elements[0].text, "Hello ".to_string());
assert_eq!(rs.elements[1].text, "world!".to_string());
assert!(rs.elements[1].is_bold());

Fields

elements: Vec<Element>

Implementations

impl RichString

pub fn new() -> Self

Create a new, empty, RichString.

pub fn char_count(&self) -> usize

The total length of a RichString, meaning the total number of chars.

pub fn get_char(&self, index: usize) -> Option<char>

Gets a char from a “global” index, meaning the index when viewing the RichString as a single string without any style attributes taken into account.

Examples

use rustwell::rich_string::RichString;

let mut rs = RichString::from("He**llo**");

assert_eq!(rs.get_char(1), Some('e'));
assert_eq!(rs.get_char(3), Some('l'));
assert_eq!(rs.get_char(5), None);

pub fn get_element_from_index(&self, index: usize) -> Option<(&Element, usize)>

Given a “global” index, gets the Element which contains it, and the “local” index pointing to that character in the element.

Examples

use rustwell::rich_string::RichString;

let mut rs = RichString::from("He**ll**o");

assert!(matches!(rs.get_element_from_index(1), Some((_, 1))));
assert!(matches!(rs.get_element_from_index(2), Some((_, 0))));
assert!(matches!(rs.get_element_from_index(3), Some((_, 1))));
assert!(matches!(rs.get_element_from_index(4), Some((_, 0))));

pub fn iter(&self) -> RichIterator<'_>

Creates an char iterator over the RichString, without the style attributes of each char taken into account.

pub fn append(&mut self, other: Self)

Appends a RichString to self. Will merge the last Element of self, and the first of the other if they have the same style attributes.

pub fn push_str(&mut self, str: impl AsRef<str>)

Pushes a string onto the RichString. Will divide the string into multiple elements with different styles if input string can be parsed with styles.

pub fn to_plain_string(&self) -> String

Converts the RichString to a plain String by just combining the string elements without adding delimiters.

Examples

use rustwell::rich_string::RichString;

let mut rs = RichString::from("He**ll**o");

assert_eq!(rs.to_plain_string(), "Hello".to_string());

Trait Implementations

impl Clone for RichString

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 RichString

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

Formats the value using the given formatter.

impl Default for RichString

fn default() -> Self

Returns the “default value” for a type.

impl Display for RichString

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

Formats the value using the given formatter.

impl Eq for RichString

impl<T> From<T> for RichString

where T: AsRef<str>,

fn from(str: T) -> Self

Converts to this type from the input type.

impl Hash for RichString

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

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 RichString

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RichString