Struct quetta::Text

pub struct Text(_);

The primary type of quetta, representing an immutable sequence of characters. Internally, this can be either a full string or a slice into another Text. Can be cloned cheaply.

Implementations

impl Text

pub fn new<'a, I: Into<&'a str>>(s: I) -> Self

Creates a new Text by copying the provided slice.

pub fn as_str(&self) -> &str

Gets the Text as a slice.

pub fn substring(&self, start: usize, len: usize) -> Text

Creates another Text with a provided start code point and length. Will panic if the substring exceeds the Text’s bounds.

Example

use quetta::Text;

let text = Text::new("qwerty");
let sub = text.substring(0, 2);
assert_eq!("qw", sub.as_str());

pub fn slice(&self, start: usize, end: usize) -> Text

Creates another Text with a provided start code point and end code point, similar to the slice operator. Will panic if the slice exceeds the Text’s bounds.

Example

use quetta::Text;

let text = Text::new("qwerty");
let sub = text.slice(1, 3);
assert_eq!("we", sub.as_str());

pub fn len(&self) -> usize

Gets the length of the Text.

Example

use quetta::Text;

let text = Text::new("I was born in a water moon");
assert_eq!(26, text.len());

pub fn is_empty(&self) -> bool

Is this Text empty?

Example

use quetta::Text;

let text = Text::default();
assert!(text.is_empty());

pub fn try_lift_slice(&self, slice: &str) -> Option<Text>

Attempt to create a Text from a slice sliced from this Text. Will return None if the slice is not contained in self.

Example

use quetta::Text;

let text = Text::new("Test");
let s = &text.as_str()[0..2];
let st = text.try_lift_slice(s);
assert!(st.is_some());
assert_eq!("Te", st.unwrap().as_str());

pub fn lift_slice(&self, slice: &str) -> Text

Creates a Text from a slice, if possible, as a substring of self.

Example

use quetta::Text;

let text = Text::new("Test");
let s = &text.as_str()[0..2];
let st = text.lift_slice(s);
assert_eq!("Te", st.as_str());

pub fn try_lift<F: Fn(&str) -> &str>(&self, f: F) -> Option<Text>

Lifts a function &str -> &str so it will be executed on the &str self. Will return none if the &str returned by the function is not contained in self.

Example

use quetta::Text;

let text = Text::new("  a  ");
let trimmed = text.try_lift(|t| t.trim())?;
assert_eq!("a", trimmed.as_str());

pub fn lift<F: Fn(&str) -> &str>(&self, f: F) -> Text

Lifts a function &str -> &str so it will be executed on the &str self. If the returned &str is not contained in self, a new Text will be created from it.

Example

use quetta::Text;

let text = Text::new("  a  ");
let trimmed = text.try_lift(|t| t.trim())?;
assert_eq!("a", trimmed.as_str());

pub fn try_lift_many<'a, I: Iterator<Item = &'a str> + 'a, F: Fn(&'a str) -> I>(
    &'a self,
    f: F
) -> impl Iterator<Item = Text> + 'a

Lifts a function &str -> Iterator<Item=&str> so it will be executed on self and returns an Iterator<Item=[Text]>. If one of the &str in the iterator is not contained in self, the iterator will end.

Example

use quetta::Text;
let t = Text::new("A:B:C:D");
let lifted: Vec<Text> = t.try_lift_many(|s| s.split(":")).collect();
assert_eq!(4, lifted.len());
assert_eq!("A", lifted[0].as_str());
assert_eq!("B", lifted[1].as_str());
assert_eq!("C", lifted[2].as_str());
assert_eq!("D", lifted[3].as_str());

pub fn lift_many<'a, I: Iterator<Item = &'a str> + 'a, F: Fn(&'a str) -> I>(
    &'a self,
    f: F
) -> impl Iterator<Item = Text> + 'a

Lifts a function &str -> Iterator<Item=&str> so it will be executed on self and returns an Iterator<Item=[Text]>. If the iterator yields a &str that is not contained within self, a new Text will be created from it.

Example

use quetta::Text;
let t = Text::new("A:B:C:D");
let lifted: Vec<Text> = t.lift_many(|s| s.split(":")).collect();
assert_eq!(4, lifted.len());
assert_eq!("A", lifted[0].as_str());
assert_eq!("B", lifted[1].as_str());
assert_eq!("C", lifted[2].as_str());
assert_eq!("D", lifted[3].as_str());

Trait Implementations

impl AsRef<str> for Text

fn as_ref(&self) -> &str

Performs the conversion.

impl Borrow<str> for Text

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for Text

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Text

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

Formats the value using the given formatter.

impl Default for Text

fn default() -> Self

Returns the “default value” for a type.

impl Display for Text

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

Formats the value using the given formatter.

impl<'a> From<&'a Text> for String

fn from(text: &'a Text) -> Self

Performs the conversion.

impl<'a> From<&'a Text> for &'a str

fn from(t: &'a Text) -> Self

Performs the conversion.

impl<'a> From<&'a str> for Text

fn from(t: &'a str) -> Self

Performs the conversion.

impl FromStr for Text

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Text

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, 

Feeds a slice of this type into the given Hasher.

impl<'a, Idx: SliceIndex<str>> Index<Idx> for &'a Text

type Output = Idx::Output

The returned type after indexing.

fn index(&self, index: Idx) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, Idx: SliceIndex<str>> Index<Idx> for Text

type Output = Idx::Output

The returned type after indexing.

fn index(&self, index: Idx) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Ord for Text

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Text> for Text

fn eq(&self, other: &Self) -> 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 !=.

impl PartialOrd<Text> for Text

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Text