Struct HeadTailStr

pub struct HeadTailStr<'a> { /* private fields */ }

Struct returned from HeadTail::head_tail()

This struct:

• Implements no-allocation PartialEq with str
• Implements Display and thus .to_string()
• Can selectively show head/tail portions
• Can indicate whether the input string was actually cut or not

Implementations

impl<'a> HeadTailStr<'a>

pub const fn cut(&self) -> bool

Returns true is the string was cut in any way.

Returns false if running .to_string() on this would result in the same string as the input string.

pub const fn head(&self) -> &str

Return the only head portion of the string

pub const fn tail(&self) -> &str

Return the only tail portion of the string

pub const fn into_parts(self) -> (&'a str, Option<&'a str>)

Returns the inner head/tail str’s that make this type up.

The returned &'a str is the head portion. If the entire input string could fit, then this will contain the entire input string and tail will be None.

The returned Option<&'a str> is the tail portion. If this is Some that means the input string was cut. If it is None that means the input string was not cut and the entire input resides inside the head portion.

let string = "hello world";

// Input (6+5 == 11) can capture the whole string.
let headtail = string.head_tail(6, 5);

// So there is no tail, everything is in head.
let (head, tail) = headtail.into_parts();
assert_eq!(head, string);
assert_eq!(tail, None);

// If it can't capture it all (5+5 != 11), then there is a tail.
let headtail = string.head_tail(5, 5);
let (head, tail) = headtail.into_parts();
assert_eq!(head, "hello");
assert_eq!(tail, Some("world"));

Trait Implementations

impl<'a> Clone for HeadTailStr<'a>

fn clone(&self) -> HeadTailStr<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for HeadTailStr<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for HeadTailStr<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for HeadTailStr<'_>

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

Formats the value using the given formatter.

impl<'a> Hash for HeadTailStr<'a>

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<'a> Ord for HeadTailStr<'a>

fn cmp(&self, other: &HeadTailStr<'a>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<&str> for HeadTailStr<'_>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<str> for HeadTailStr<'_>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> PartialEq for HeadTailStr<'a>

fn eq(&self, other: &HeadTailStr<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> PartialOrd for HeadTailStr<'a>

fn partial_cmp(&self, other: &HeadTailStr<'a>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> Serialize for HeadTailStr<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Copy for HeadTailStr<'a>

impl<'a> Eq for HeadTailStr<'a>

impl<'a> StructuralPartialEq for HeadTailStr<'a>