Trait similar::DiffableStr

pub trait DiffableStr: Hash + PartialEq + PartialOrd + Ord + Eq + ToOwned {
    // Required methods
    fn tokenize_lines(&self) -> Vec<&Self>;
    fn tokenize_lines_and_newlines(&self) -> Vec<&Self>;
    fn tokenize_words(&self) -> Vec<&Self>;
    fn tokenize_chars(&self) -> Vec<&Self>;
    fn as_str(&self) -> Option<&str>;
    fn to_string_lossy(&self) -> Cow<'_, str>;
    fn ends_with_newline(&self) -> bool;
    fn len(&self) -> usize;
    fn slice(&self, rng: Range<usize>) -> &Self;
    fn as_bytes(&self) -> &[u8] ;

    // Provided method
    fn is_empty(&self) -> bool { ... }
}

All supported diffable strings.

The text module can work with different types of strings depending on how the crate is compiled. Out of the box &str is always supported but with the bytes feature one can also work with [u8] slices for as long as they are ASCII compatible.

Requires the text feature.

Required Methods

fn tokenize_lines(&self) -> Vec<&Self>

Splits the value into newlines with newlines attached.

fn tokenize_lines_and_newlines(&self) -> Vec<&Self>

Splits the value into newlines with newlines separated.

fn tokenize_words(&self) -> Vec<&Self>

Tokenizes into words.

fn tokenize_chars(&self) -> Vec<&Self>

Tokenizes the input into characters.

fn as_str(&self) -> Option<&str>

Decodes the string (potentially) lossy.

fn to_string_lossy(&self) -> Cow<'_, str>

Decodes the string (potentially) lossy.

fn ends_with_newline(&self) -> bool

Checks if the string ends in a newline.

fn len(&self) -> usize

The length of the string.

fn slice(&self, rng: Range<usize>) -> &Self

Slices the string.

fn as_bytes(&self) -> &[u8]

Returns the string as slice of raw bytes.

Provided Methods

fn is_empty(&self) -> bool

Checks if the string is empty.

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl DiffableStr for str

fn tokenize_lines(&self) -> Vec<&Self>

fn tokenize_lines_and_newlines(&self) -> Vec<&Self>

fn tokenize_words(&self) -> Vec<&Self>

fn tokenize_chars(&self) -> Vec<&Self>

fn as_str(&self) -> Option<&str>

fn to_string_lossy(&self) -> Cow<'_, str>

fn ends_with_newline(&self) -> bool

fn len(&self) -> usize

fn slice(&self, rng: Range<usize>) -> &Self

fn as_bytes(&self) -> &[u8]

Implementors