Struct FragmentBuf 

pub struct FragmentBuf<B, D, P> { /* private fields */ }

A dynamic, growable Fragment.

This type can either be constructed directly, or can be returned as a result from some operation on another chunk, fragment, or identifier which may not leave it in the original checked format (like removing part of an identifier and ending up with something which is not validly an identifier any more).

This allows you to build a fragment dynamically, instead of having to get a fragment from an identifier slice. Every operation performed to mutate a fragment will be checked to ensure that the result is still a valid fragment.

This is also how one is expected to build a dynamic identifier from scratch. Start with a FragmentBuf, make the modifications you want to make, then attempt to convert it into either an &Ident or Box<Ident>.

Construction

If you want to construct a new fragment buffer, it is expected that you do so through some type alias which fully defines the fragment buffer.

The common way to get a reasonable alias is through the presets module.

use typed_ident::syntax::delimiter::*;
use typed_ident::presets::unicode::lower_snake::LowerSnakeFragmentBuf;

// You can build a fragment buffer dynamically.
let mut buffer = LowerSnakeFragmentBuf::new();
buffer.push("lower")?;
buffer.push(LowLine)?;
buffer.push("snake")?;

// When you're done with it, you can cast it to a fragment.
let fragment = buffer.as_fragment();
assert_eq!(fragment, "lower_snake");

// Or, if it forms a valid identifier, to a identifier.
let ident = buffer.as_ident()?;
assert_eq!(fragment, "lower_snake");

These presets are all just type aliases to FragmentBuf with the generic type parameters filled-in. If you would like to define your own custom fragment buffer, it’s recommended that you do so by defining your own type alias.

use typed_ident::FragmentBuf;
use typed_ident::syntax::{boundary, delimiter, profile};

// An ASCII fragment using the uppercase ASCII profile.
// Any ASCII punctuation is rejected as delimiters.
type CustomFragmentBuf = FragmentBuf<
    boundary::Standard,
    delimiter::AsciiPunctuation,
    profile::Upper<profile::Ascii>,
>;

let ident = CustomFragmentBuf::from_str("UPPER#@IDENT")?;

Type Parameters

The type parameters used on this type are:

• B: Boundary (a boundary definition; usually Standard)
• D: Delimiter (a delimiter type; HyphenMinus, LowLine, etc.)
• P: CasedProfile (a cased profile; which is…)
  • A wrapping case profile (e.g. Mixed, Lower, etc.)
  • A specific character profile (e.g. Ascii, Unicode, etc.)

See the syntax module definition if you plan on defining your own type aliases to understand better what these types mean and how they work.

Implementations

impl<B: Boundary, D: Delimiter, P: CasedProfile> FragmentBuf<B, D, P>

pub fn as_ident(&self) -> Result<&Ident<B, D, P>, Error>

Attempts to represent the current fragment buffer as an Ident.

This may fail - a fragment isn’t obviously a valid identifier, plus the fragment could be empty (which is never a valid identifier).

Errors

Returns Error if the fragment does not satisfy the identifier character requirements. If the fragment is empty, this will return an Empty error kind. If an invalid character is found then a InvalidFormat error kind is returned, with byte_offset set to the byte index for the first invalid character.

Examples

Basic Usage:

let mut buffer = HybridFragmentBuf::new();
assert!(buffer.as_ident().is_err()); // Empty
buffer.push('2')?;
assert!(buffer.as_ident().is_err()); // Invalid start character

buffer.clear();
buffer.push('a')?;
assert!(buffer.as_ident().is_ok()); // Valid!

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

Constructs a fragment buffer, initializing the contents to a provided string slice (attempting first to convert the string slice to a valid fragment).

This is equivalent to FragmentBuf::from_fragment(Fragment::new(s)?).

Errors

Returns Error if the fragment does not satisfy the character requirements. If an invalid character is found then a InvalidFormat error kind is returned, with byte_offset set to the byte index for the first invalid character.

Examples

Basic Usage:

assert!(UpperCamelFragmentBuf::from_str("").is_ok());
assert!(UpperCamelFragmentBuf::from_str("ValidUpperCamel").is_ok());
assert!(UpperCamelFragmentBuf::from_str("continuingUpperCamel").is_ok());
assert!(UpperCamelFragmentBuf::from_str("not_validUpperCamel").is_err());

pub fn from_string(s: String) -> Result<Self, Error>

Constructs a fragment buffer, initializing the contents to a provided buffered string (checking first that the string is a valid fragment).

This is similar to from_str, except that it will not allocate a separate string. It will use the provided string, if it’s valid.

Errors

Returns Error if the fragment does not satisfy the character requirements. If an invalid character is found then a InvalidFormat error kind is returned, with byte_offset set to the byte index for the first invalid character.

Examples

Basic Usage:

assert!(UpperCamelFragmentBuf::from_string(String::from("")).is_ok());
assert!(UpperCamelFragmentBuf::from_string(String::from("ValidUpperCamel")).is_ok());
assert!(UpperCamelFragmentBuf::from_string(String::from("continuingUpperCamel")).is_ok());
assert!(UpperCamelFragmentBuf::from_string(String::from("not_validUpperCamel")).is_err());

pub fn insert<F>(&mut self, idx: usize, fragment: F) -> Result<(), Error>

where F: IntoIntermediate<B, D, P>,

Attempts to insert a fragment into the buffer.

This function takes anything that can be represented as an intermediate fragment. That means it can take a &str, char, Fragment, Chunk, Identifier, or Segment.

Panics

This function will panic if the byte index is larger than the element’s length, or if it does not fall on a character sequence boundary.

Errors

Returns Error if the intermediate fragment provided is invalid, or if the insertion of fragment into self cannot produce a valid result.

If the intermediate fragment is invalid, then the InvalidFormat error kind will be returned, with the byte_offset set to the first invalid character of the intermediate fragment.

If the insertion operation itself failed, then the FailedInsert error kind is returned, without setting the byte_offset.

Examples

Basic Usage:

let mut buffer = UpperCamelFragmentBuf::from_str("UpperCamel")?;

// Inserting at the beginning is ~prepend.
let mut example = buffer.clone();
assert!(example.insert(0, 'V').is_ok());
assert!(example.insert(0, '_').is_ok());
assert_eq!(example, "_VUpperCamel");

// Inserting at the end is ~append.
let mut example = buffer.clone();
example.push('_')?;
assert!(example.insert(example.len(), 'i').is_err());
assert!(example.insert(example.len(), 'V').is_ok());
assert_eq!(example, "UpperCamel_V");

// Inserting in the middle can be tricky, as your insertions
// may invalidate the buffer's invariants in surprising ways.
let mut example = buffer.clone();
assert!(example.insert(2, '_').is_err()); // "Up_perCamel" != UpperCamel casing
assert!(example.insert(5, '_').is_ok());
assert_eq!(example, "Upper_Camel");

pub fn insert_bounded<F>( &mut self, idx: usize, fragment: F, ) -> Result<(), Error>

where D: Default, F: IntoIntermediate<B, D, P>,

Attempts to insert a fragment into the buffer, preserving chunk boundaries by conditionally inserting delimiters where needed.

This is a convenience function for cases when the delimiter value can be deduced by the Default trait. For more information on this operation, see the insert_bounded_with method.

Examples

Basic Usage:

let mut buffer = UpperCamelFragmentBuf::from_str("UpperCamel")?;

// Inserting at the beginning is ~prepend.
let mut example = buffer.clone();
assert!(example.insert_bounded(0, 'V').is_ok()); // Bounded because of `HAT` rules.
assert!(example.insert_bounded(0, 'V').is_ok()); // But another `V` would not be.
assert_eq!(example, "V_VUpperCamel");

// Inserting at the end is ~append.
let mut example = buffer.clone();
assert!(example.insert_bounded(example.len(), 'i').is_err()); // "UpperCamel_i" != UpperCamel casing
assert!(example.insert_bounded(example.len(), 'V').is_ok()); // Because of `CAMEL` boundary.
assert_eq!(example, "UpperCamelV");

// Inserting in the middle can be tricky, as your insertions
// may invalidate the buffer's invariants in surprising ways.
let mut example = buffer.clone();
assert!(example.insert_bounded(2, 'V').is_err()); // "Up_V_perCamel" != UpperCamel casing
assert!(example.insert_bounded(5, 'V').is_ok()); // Surprisingly a `CAMEL` & `HAT` boundary.
assert_eq!(example, "UpperVCamel");

pub fn insert_bounded_with<F>( &mut self, idx: usize, fragment: F, delim: D, ) -> Result<(), Error>

where F: IntoIntermediate<B, D, P>,

Attempts to insert a fragment into the buffer, preserving chunk boundaries by conditionally inserting delimiters where needed.

This function takes anything that can be represented as an intermediate fragment. That means it can take a &str, char, Fragment, Chunk, Identifier, or Segment.

If you’re working with a fragment format which has only a single valid delimiter value, you should instead be able to use the insert_bounded method, and should prefer that.

Preserving Chunk Boundaries

If the fragment already contains delimiters on both ends, it will always be inserted verbatim.

If the fragment does NOT contain delimiters on both ends, the fragment will first be inserted, and then it will be tested to ensure that both sides of the fragment don’t merge into the surrounding chunks. If they would, a delimiter will be inserted to force separation.

Whether or not a delimiter is needed is found using the Boundary trait. The general strategy for bounded insertion looks like this:

1. The string is inserted into the current fragment.
2. Boundary::has_boundary_at is called on both the beginning and end of the insertion indices, to ensure there’s still a boundary between the ends of the original fragment and the inserted fragment.
3. If there’s no boundary, the delim character is inserted at the necessary locations to force a boundary.

The goal of any bounded insertion operation is not to merge chunks.

Panics

This function will panic if the byte index is larger than the element’s length, or if it does not fall on a character sequence boundary.

Errors

Returns Error if the intermediate fragment provided is invalid, or if the insertion of fragment into self cannot produce a valid result.

If the intermediate fragment is invalid, then the InvalidFormat error kind will be returned, with the byte_offset set to the first invalid character of the intermediate fragment.

If the insertion operation itself failed, then the FailedInsert error kind is returned, without setting the byte_offset.

Examples

Basic Usage:

let mut buffer = UpperCamelFragmentBuf::from_str("UpperCamel")?;

// Inserting at the beginning is ~prepend.
let mut example = buffer.clone();
assert!(example.insert_bounded_with(
    0,
    UpperCamelFragment::new("HAT")?,
    LowLine,
).is_ok()); // Bounded because of `HAT` rules.
assert!(example.insert_bounded_with(
    0,
    UpperCamelFragment::new("HAT")?,
    LowLine,
).is_ok()); // But another would not be.
assert_eq!(example, "HAT_HATUpperCamel");

// Inserting at the end is ~append.
let mut example = buffer.clone();
assert!(example.insert_bounded_with(
    example.len(),
    UpperCamelFragment::new("lower")?,
    LowLine,
).is_err()); // "UpperCamel_lower" != UpperCamel casing
assert!(example.insert_bounded_with(
    example.len(),
    UpperCamelFragment::new("Camel")?,
    LowLine,
).is_ok()); // Because of `CAMEL` boundary.
assert_eq!(example, "UpperCamelCamel");

// Inserting in the middle can be tricky, as your insertions
// may invalidate the buffer's invariants in surprising ways.
let mut example = buffer.clone();
assert!(example.insert_bounded_with(
    2,
    UpperCamelFragment::new("HAT")?,
    LowLine,
).is_err()); // "UpHAT_perCamel" != UpperCamel casing
assert!(example.insert_bounded_with(
    5,
    UpperCamelFragment::new("HAT")?,
    LowLine,
).is_ok()); // Surprisingly a `CAMEL` & `HAT` boundary.
assert_eq!(example, "UpperHATCamel");

pub fn insert_delimited<F>( &mut self, idx: usize, fragment: F, ) -> Result<(), Error>

where D: Default, F: IntoIntermediate<B, D, P>,

Attempts to insert a fragment into the buffer, preserving chunk boundaries by ensuring a delimiter is present on each side (where needed).

This is a convenience function for cases when the delimiter value can be deduced by the Default trait. For more information on this operation, see the insert_delimited_with method.

Examples

Basic Usage:

let mut buffer = UpperCamelFragmentBuf::from_str("UpperCamel")?;

// Inserting at the beginning is ~prepend.
let mut example = buffer.clone();
assert!(example.insert_delimited(0, 'V').is_ok());
assert_eq!(example, "V_UpperCamel");

// Inserting at the end is ~append.
let mut example = buffer.clone();
assert!(example.insert_delimited(example.len(), 'i').is_err()); // "UpperCamel_i" != UpperCamel casing
assert!(example.insert_delimited(example.len(), 'V').is_ok());
assert_eq!(example, "UpperCamel_V");

// Inserting in the middle can be tricky, as your insertions
// may invalidate the buffer's invariants in surprising ways.
let mut example = buffer.clone();
assert!(example.insert_delimited(2, 'V').is_err()); // "Up_V_perCamel" != UpperCamel casing
assert!(example.insert_delimited(5, 'V').is_ok());
assert_eq!(example, "Upper_V_Camel");

pub fn insert_delimited_with<F>( &mut self, idx: usize, fragment: F, delim: D, ) -> Result<(), Error>

where F: IntoIntermediate<B, D, P>,

Attempts to insert a fragment into the buffer, preserving chunk boundaries by ensuring a delimiter is present on each side (where needed).

This function takes anything that can be represented as an intermediate fragment. That means it can take a &str, char, Fragment, Chunk, Identifier, or Segment.

If you’re working with a fragment format which has only a single valid delimiter value, you should instead be able to use the insert_delimited method, and should prefer that.

Preserving Chunk Boundaries

If the fragment already contains delimiters on both ends, it will always be inserted verbatim.

If the fragment does NOT contain delimiters on both ends, then a delimiter will be inserted a number of times depending on how many sides have chunk data immediately next to the insertion points. Finally, the fragment itself will be inserted such that the inserted delimiters will fall on the left or right depending on where they were intended.

Panics

This function will panic if the byte index is larger than the element’s length, or if it does not fall on a character sequence boundary.

Errors

Returns Error if the intermediate fragment provided is invalid, or if the insertion of fragment into self cannot produce a valid result.

If the intermediate fragment is invalid, then the InvalidFormat error kind will be returned, with the byte_offset set to the first invalid character of the intermediate fragment.

If the insertion operation itself failed, then the FailedInsert error kind is returned, without setting the byte_offset.

Examples

Basic Usage:

let mut buffer = UpperCamelFragmentBuf::from_str("UpperCamel")?;

// Inserting at the beginning is ~prepend.
let mut example = buffer.clone();
assert!(example.insert_delimited_with(
    0,
    UpperCamelFragment::new("HAT")?,
    LowLine,
).is_ok());
assert_eq!(example, "HAT_UpperCamel");

// Inserting at the end is ~append.
let mut example = buffer.clone();
assert!(example.insert_delimited_with(
    example.len(),
    UpperCamelFragment::new("lower")?,
    LowLine,
).is_err()); // "UpperCamel_lower" != UpperCamel casing
assert!(example.insert_delimited_with(
    example.len(),
    UpperCamelFragment::new("Camel")?,
    LowLine,
).is_ok());
assert_eq!(example, "UpperCamel_Camel");

// Inserting in the middle can be tricky, as your insertions
// may invalidate the buffer's invariants in surprising ways.
let mut example = buffer.clone();
assert!(example.insert_delimited_with(
    2,
    UpperCamelFragment::new("HAT")?,
    LowLine,
).is_err()); // "Up_HAT_perCamel" != UpperCamel casing
assert!(example.insert_delimited_with(
    5,
    UpperCamelFragment::new("HAT")?,
    LowLine,
).is_ok());
assert_eq!(example, "Upper_HAT_Camel");

pub fn into_boxed_ident(self) -> Result<Box<Ident<B, D, P>>, Error>

Attempts to convert the current fragment buffer into a boxed Ident.

This may fail - a fragment isn’t obviously a valid identifier, plus the fragment could be empty (which is never a valid identifier).

Errors

Returns Error if the fragment does not satisfy the identifier character requirements. If the fragment is empty, this will return an Empty error kind. If an invalid character is found then a InvalidFormat error kind is returned, with byte_offset set to the byte index for the first invalid character.

Examples

Basic Usage:

let mut buffer = HybridFragmentBuf::new();
assert!(buffer.into_boxed_ident().is_err()); // Empty

let mut buffer = HybridFragmentBuf::new();
buffer.push('2')?;
assert!(buffer.into_boxed_ident().is_err()); // Invalid start character

let mut buffer = HybridFragmentBuf::new();
buffer.push('a')?;
assert!(buffer.into_boxed_ident().is_ok()); // Valid!

pub fn push<F>(&mut self, fragment: F) -> Result<(), Error>

where F: IntoIntermediate<B, D, P>,

Attempts to push a fragment onto the buffer.

This function takes anything that can be represented as an intermediate fragment. That means it can take a &str, char, Fragment, Chunk, Identifier, or Segment.

Errors

Returns Error if the intermediate fragment provided is invalid, or if the pushing of fragment onto self cannot produce a valid result.

If the intermediate fragment is invalid, then the InvalidFormat error kind will be returned, with the byte_offset set to the first invalid character of the intermediate fragment.

If the push operation itself failed, then the FailedPush error kind is returned, without setting the byte_offset.

Examples

Basic Usage:

let mut buffer = UpperCamelFragmentBuf::new();

// You can only push characters that are valid at the given position.
assert!(buffer.push('O').is_ok());
assert!(buffer.push('k').is_ok());
assert_eq!(buffer, "Ok");

// But you have to be mindful of the format to avoid pushing
// invalid characters. Most commonly, after delimiters.
buffer.push('_')?;
assert!(buffer.push('i').is_err());

pub fn push_bounded<F>(&mut self, fragment: F) -> Result<(), Error>

where D: Default, F: IntoIntermediate<B, D, P>,

Attempts to push a fragment onto the buffer, preserving chunk boundaries by conditionally inserting delimiters if needed.

This is a convenience function for cases when the delimiter value can be deduced by the Default trait. For more information on this operation, see the push_bounded_with method.

Examples

Basic Usage:

let mut buffer = UpperCamelFragmentBuf::new();

// If there's no data at the start, there's nothing to bound against.
assert!(buffer.push_bounded('O').is_ok());
assert_eq!(buffer, "O");

// But the very next bounded push would need to bound the contents.
// As such, you cannot select an invalid character.
assert!(buffer.push_bounded('k').is_err()); // "O_k" != UpperCamel casing
assert!(buffer.push_bounded('K').is_ok());
assert_eq!(buffer, "O_K");

// This won't add a delimiter if the chunks are already bounded.
assert!(buffer.push('o').is_ok()); // Regular push to get a lowercase.
assert!(buffer.push_bounded('K').is_ok()); // A `CAMEL` boundary char.
assert_eq!(buffer, "O_KoK");

// If there's already a delimiter, another would not be inserted.
assert!(buffer.push(LowLine).is_ok());
assert!(buffer.push_bounded('K').is_ok());
assert_eq!(buffer, "O_KoK_K");

pub fn push_bounded_with<F>( &mut self, fragment: F, delim: D, ) -> Result<(), Error>

where F: IntoIntermediate<B, D, P>,

Attempts to push a fragment into the buffer, preserving chunk boundaries by conditionally inserting delimiters if needed.

This function takes anything that can be represented as an intermediate fragment. That means it can take a &str, char, Fragment, Chunk, Identifier, or Segment.

If you’re working with a fragment format which has only a single valid delimiter value, you should instead be able to use the push_bounded method, and should prefer that.

Preserving Chunk Boundaries

If the fragment already contains delimiters on the left, it will always be inserted verbatim.

If the fragment does NOT contain delimiters on the left, the fragment will first be pushed, and then it will be tested to ensure that the left side of the fragment didn’t merge into the prior chunk. If it did, a delimiter will be inserted to force separation.

Whether or not a delimiter is needed is found using the Boundary trait. The general strategy for bounded push looks like this:

1. The string is pushed onto the current fragment.
2. Boundary::has_boundary_at is called with the original fragment length, to ensure there’s still a boundary between the end of the original fragment and the pushed fragment.
3. If there’s no boundary, the delim character is inserted at the necessary location to force a boundary.

The goal of any bounded push operation is not to merge chunks.

Errors

Returns Error if the intermediate fragment provided is invalid, or if the pushing of fragment onto self cannot produce a valid result.

If the intermediate fragment is invalid, then the InvalidFormat error kind will be returned, with the byte_offset set to the first invalid character of the intermediate fragment.

If the push operation itself failed, then the FailedPush error kind is returned, without setting the byte_offset.

Examples

Basic Usage:

let mut buffer = UpperCamelFragmentBuf::new();

// If there's no data at the start, there's nothing to bound against.
assert!(buffer.push_bounded_with('O', LowLine).is_ok());
assert_eq!(buffer, "O");

// But the very next bounded push would need to bound the contents.
// As such, you cannot select an invalid character.
assert!(buffer.push_bounded_with('k', LowLine).is_err()); // "O_k" != UpperCamel casing
assert!(buffer.push_bounded_with('K', LowLine).is_ok());
assert_eq!(buffer, "O_K");

// This won't add a delimiter if the chunks are already bounded.
assert!(buffer.push('o').is_ok()); // Regular push to get a lowercase.
assert!(buffer.push_bounded_with('K', LowLine).is_ok()); // A `CAMEL` boundary char.
assert_eq!(buffer, "O_KoK");

// If there's already a delimiter, another would not be inserted.
assert!(buffer.push(LowLine).is_ok());
assert!(buffer.push_bounded_with('K', LowLine).is_ok());
assert_eq!(buffer, "O_KoK_K");

pub fn push_delimited<F>(&mut self, fragment: F) -> Result<(), Error>

where D: Default, F: IntoIntermediate<B, D, P>,

Attempts to push a fragment into the buffer, preserving chunk boundaries by ensuring a delimiter is present on the left side (if needed).

This is a convenience function for cases when the delimiter value can be deduced by the Default trait. For more information on this operation, see the push_delimited_with method.

Examples

Basic Usage:

let mut buffer = UpperCamelFragmentBuf::new();

// If there's no data at the start, there's nothing to delimit against.
assert!(buffer.push_delimited('O').is_ok());
assert_eq!(buffer, "O");

// But the very next delimited push would need to delimit the contents.
// As such, you cannot select an invalid character.
assert!(buffer.push_delimited('k').is_err()); // "O_k" != UpperCamel casing
assert!(buffer.push_delimited('K').is_ok());
assert_eq!(buffer, "O_K");

// If there's already a delimiter, another would not be inserted.
assert!(buffer.push(LowLine).is_ok());
assert!(buffer.push_delimited('K').is_ok());
assert_eq!(buffer, "O_K_K");

pub fn push_delimited_with<F>( &mut self, fragment: F, delim: D, ) -> Result<(), Error>

where F: IntoIntermediate<B, D, P>,

Attempts to push a fragment into the buffer, preserving chunk boundaries by ensuring a delimiter is present on the left side (if needed).

This function takes anything that can be represented as an intermediate fragment. That means it can take a &str, char, Fragment, Chunk, Identifier, or Segment.

If you’re working with a fragment format which has only a single valid delimiter value, you should instead be able to use the push_delimited method, and should prefer that.

Preserving Chunk Boundaries

If the fragment already contains delimiters on the left, it will be inserted verbatim.

If the fragment does NOT contain delimiters on the left, and the prior fragment did not contain a delimiter on the right, then a delimiter will be pushed first. Finally, the fragment itself will be pushed.

Errors

Returns Error if the intermediate fragment provided is invalid, or if the pushing of fragment onto self cannot produce a valid result.

If the intermediate fragment is invalid, then the InvalidFormat error kind will be returned, with the byte_offset set to the first invalid character of the intermediate fragment.

If the push operation itself failed, then the FailedPush error kind is returned, without setting the byte_offset.

Examples

Basic Usage:

let mut buffer = UpperCamelFragmentBuf::new();

// If there's no data at the start, there's nothing to delimit against.
assert!(buffer.push_delimited_with('O', LowLine).is_ok());
assert_eq!(buffer, "O");

// But the very next delimited push would need to delimit the contents.
// As such, you cannot select an invalid character.
assert!(buffer.push_delimited_with('k', LowLine).is_err()); // "O_k" != UpperCamel casing
assert!(buffer.push_delimited_with('K', LowLine).is_ok());
assert_eq!(buffer, "O_K");

// If there's already a delimiter, another would not be inserted.
assert!(buffer.push(LowLine).is_ok());
assert!(buffer.push_delimited_with('K', LowLine).is_ok());
assert_eq!(buffer, "O_K_K");

pub fn remove(&mut self, idx: usize) -> Result<(), Error>

Removes a character from the buffer at a given index.

Panics

This function will panic if the byte index is larger than the element’s length, or if it does not fall on a character sequence boundary.

Errors

If the removal of the character at the provided index would lead to an invalid buffer, then the character will not be remove and instead the error FailedRemove will be returned.

Examples

Basic Usage:

let mut buffer = UpperCamelFragmentBuf::from_str("Upper_Camel")?;

// This would be valid, because it might be a continuation fragment.
assert!(buffer.remove(0).is_ok());
assert_eq!(buffer, "pper_Camel");

// However, attempting to remove `C` would fail for `UpperCamel`.
assert!(buffer.remove(5).is_err());
assert_eq!(buffer, "pper_Camel");

pub fn replace_range<R, F>( &mut self, range: R, replace_with: F, ) -> Result<(), Error>

where R: RangeBounds<usize>, F: IntoIntermediate<B, D, P>,

Replace a range of characters with a provided replacement fragment.

This function takes anything that can be represented as an intermediate fragment. That means it can take a &str, char, Fragment, Chunk, Identifier, or Segment.

Panics

This function will panic if either end of the range specified lies outside of the length of the fragment, or if either end does not lie on a character sequence boundary.

Errors

If the replacement of the range provided with the given fragment would lead to an invalid buffer, then the range will not be remove and instead the error FailedReplace will be returned.

Examples

Basic Usage:

let mut buffer = UpperCamelFragmentBuf::from_str("Upper_Camel")?;

// Examples replacing various ranges.
let mut example = buffer.clone();
assert!(example.replace_range(4..7, "R").is_ok());
assert_eq!(example, "UppeRamel");

let mut example = buffer.clone();
assert!(example.replace_range(4..=7, "R").is_ok());
assert_eq!(example, "UppeRmel");

let mut example = buffer.clone();
assert!(example.replace_range(..7, "R").is_ok());
assert_eq!(example, "Ramel");

let mut example = buffer.clone();
assert!(example.replace_range(..=7, "R").is_ok());
assert_eq!(example, "Rmel");

let mut example = buffer.clone();
assert!(example.replace_range(4.., "R").is_ok());
assert_eq!(example, "UppeR");

pub fn split_off(&mut self, idx: usize) -> FragmentBuf<B, D, P>

Splits the buffer into two halves at a given byte index.

Returns a newly allocated buffer. self contains bytes [0, at), and the returned buffer contains bytes [at, len). at must be on the boundary of a UTF-8 code point.

Note that the capacity of self does not change.

Panics

This function will panic if the byte index is larger than the element’s length, or if it does not fall on a character sequence boundary.

Examples

Basic Usage:

let mut buffer = UpperCamelFragmentBuf::from_str("UpperCamel")?;
let split = buffer.split_off(5);
assert_eq!(buffer, "Upper");
assert_eq!(split, "Camel");

impl<B, D, P> FragmentBuf<B, D, P>

pub const fn as_fragment(&self) -> &Fragment<B, D, P>

Returns a reference to the fragment slice from the buffer.

Examples

Basic Usage:

let mut buffer = HybridFragmentBuf::from_str("example")?;
let fragment: &HybridFragment = buffer.as_fragment();

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

Returns a string slice representation of the buffer data.

Examples

Basic Usage:

let mut buffer = HybridFragmentBuf::from_str("example")?;
let fragment: &str = buffer.as_str();

pub fn capacity(&self) -> usize

Returns the underlying capacity of the buffer.

This has the same properties as String::capacity.

Examples

let mut buffer = HybridFragmentBuf::new();
assert_eq!(buffer.capacity(), 0);
buffer.reserve(10);
assert!(buffer.capacity() >= 10);

pub fn clear(&mut self)

Clears the underlying fragment buffer, making it empty.

This has the same properties as String::clear.

Examples

let mut buffer = HybridFragmentBuf::from_str("example")?;
assert_eq!(buffer, "example");
buffer.clear();
assert_eq!(buffer, "");

pub fn from_fragment(fragment: &Fragment<B, D, P>) -> Self

Converts a fragment slice into a fragment buffer.

Examples

let fragment = UpperCamelFragment::new("example")?;
let mut buffer = UpperCamelFragmentBuf::from_fragment(fragment);
assert_eq!(buffer, "example");

pub fn into_boxed_fragment(self) -> Box<Fragment<B, D, P>>

Convert the buffer into a boxed fragment.

Examples

let mut buffer = HybridFragmentBuf::from_str("example")?;
let boxed: Box<HybridFragment> = buffer.into_boxed_fragment();
assert_eq!(boxed.as_ref(), "example");

pub fn into_boxed_str(self) -> Box<str>

Convert the buffer into a boxed string slice.

Examples

let buffer = HybridFragmentBuf::from_str("example")?;
let boxed: Box<str> = buffer.into_boxed_str();
assert_eq!(boxed.as_ref(), "example");

pub fn into_string(self) -> String

Convert the buffer into an owned string.

Examples

let fragment = UpperCamelFragmentBuf::from_str("example")?;
let string: String = fragment.into_string();
assert_eq!(string, "example");

pub const fn is_empty(&self) -> bool

Returns true if the underlying buffer is empty.

This has the same properties as String::is_empty.

Examples

let mut buffer = HybridFragmentBuf::from_str("example")?;
assert!(!buffer.is_empty());
buffer.clear();
assert!(buffer.is_empty());

pub fn leak<'a>(self) -> &'a Fragment<B, D, P>

Leaks the fragment so that it lives for the rest of the execution of the program.

This is a typed wrapper over the String::leak method.

Examples

let fragment = UpperCamelFragmentBuf::from_str("example")?;
let string: &'static UpperCamelFragment = fragment.leak();

pub const fn len(&self) -> usize

Returns the byte length of the buffer

This has the same properties as String::len.

Examples

let mut buffer = HybridFragmentBuf::from_str("example")?;
assert_eq!(buffer.len(), 7);
buffer.clear();
assert_eq!(buffer.len(), 0);

pub fn new() -> Self

Constructs a new buffer with the capacity set to 0.

Examples

let mut buffer = HybridFragmentBuf::new();
assert_eq!(buffer, "");

pub fn pop(&mut self) -> Option<char>

Pops the right-most character off the buffer and returns it.

This has the same properties as String::pop.

Examples

let mut buffer = HybridFragmentBuf::from_str("test")?;
assert_eq!(buffer.pop(), Some('t'));
assert_eq!(buffer.pop(), Some('s'));
assert_eq!(buffer.pop(), Some('e'));
assert_eq!(buffer.pop(), Some('t'));
assert_eq!(buffer.pop(), None);

pub fn reserve(&mut self, additional: usize)

Reserves enough buffer space for additional more bytes.

This has the same properties as String::reserve.

Note

This will over-allocate in most situations. If you need to reserve an exact amount of bytes, see reserve_exact.

Examples

let mut buffer = HybridFragmentBuf::new();
assert_eq!(buffer.capacity(), 0);
buffer.reserve(10);
assert!(buffer.capacity() >= 10);

pub fn reserve_exact(&mut self, additional: usize)

Reserves exact buffer space for additional more bytes.

This has the same properties as String::reserve_exact.

Examples

let mut buffer = HybridFragmentBuf::new();
assert_eq!(buffer.capacity(), 0);
buffer.reserve_exact(10);
assert_eq!(buffer.capacity(), 10);

pub fn shrink_to(&mut self, min_capacity: usize)

Shrinks the buffer to the minimum of the actual length or the provided min_capacity value.

This has the same properties as String::shrink_to.

Examples

let mut buffer = HybridFragmentBuf::with_capacity(10);
assert!(buffer.capacity() >= 10);
buffer.shrink_to(5);
assert_eq!(buffer.capacity(), 5);
buffer.push("example")?;
assert!(buffer.capacity() >= 7);
buffer.shrink_to(0);
assert_eq!(buffer.capacity(), 7);

pub fn shrink_to_fit(&mut self)

Shrinks the buffer to the size of the content.

This has the same properties as String::shrink_to_fit.

Examples

let mut buffer = HybridFragmentBuf::with_capacity(10);
assert!(buffer.capacity() >= 10);
buffer.shrink_to_fit();
assert_eq!(buffer.capacity(), 0);
buffer.push("example")?;
assert!(buffer.capacity() >= 7);
buffer.shrink_to_fit();
assert_eq!(buffer.capacity(), 7);

pub fn truncate(&mut self, len: usize)

Truncates the buffer to the provided length.

This has the same properties as String::truncate.

Panics

This will panic if the provided len value does not lie on a character sequence boundary.

Examples

let mut buffer = HybridFragmentBuf::from_str("example")?;
assert_eq!(buffer, "example");
buffer.truncate(4);
assert_eq!(buffer, "exam");

pub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError>

Attempts to reserve buffer space for additional more bytes.

This has the same properties as String::try_reserve.

pub fn try_reserve_exact( &mut self, additional: usize, ) -> Result<(), TryReserveError>

Attempts to reserve exact buffer space for additional more bytes.

This has the same properties as String::try_reserve_exact.

pub fn with_capacity(capacity: usize) -> Self

Constructs an empty fragment buffer with an initial capacity.

This has the same properties as String::with_capacity.

Examples

let buffer = UpperCamelFragmentBuf::with_capacity(10);
assert!(buffer.capacity() >= 10);

pub fn with_overhead(fragment: &Fragment<B, D, P>, additional: usize) -> Self

Constructs a fragment with enough space to hold the provided fragment, as well as additional bytes, then initializes the contents of this buffer to fragment.

Examples

let fragment = UpperCamelFragment::new("example")?;
let buffer = UpperCamelFragmentBuf::with_overhead(fragment, 20);
assert!(buffer.capacity() >= 27);
assert_eq!(buffer, "example");

Methods from Deref<Target = Fragment<B, D, P>>

pub fn join<F>(&self, fragment: F) -> Result<FragmentBuf<B, D, P>, Error>

where D: Default, F: IntoIntermediate<B, D, P>,

Returns a heap-allocated fragment, joined with the original fragment in a way that preserves chunk boundaries.

This is a convenience function for cases when the delimiter value can be deduced by the Default trait. For more information on this operation, see the join_with method.

Examples

Basic Usage:

let fragment = LowerSnakeFragment::new("snake")?;
let fragment = fragment.join("fragment")?;
assert_eq!(fragment, "snake_fragment");

pub fn join_with<F>( &self, fragment: F, delim: D, ) -> Result<FragmentBuf<B, D, P>, Error>

where F: IntoIntermediate<B, D, P>,

Returns a heap-allocated fragment, joined with the original fragment in a way that preserves chunk boundaries.

This function takes anything that can be represented as an intermediate fragment. That means it can take a &str, char, Fragment, Chunk, Identifier, or Segment.

If you’re working with an fragment format which has only a single valid delimiter value, you should instead be able to use the join method, and should prefer that.

Preserving Chunk Boundaries

At the end of the operation, the total number of chunked segments present in the fragment will be equal to the sum of each fragment, potentially plus one additional fragment in the case where we needed to join using a delimiter to preserve chunk boundaries.

Whether or not a delimiter is needed is found using the Boundary trait. The general strategy for joining looks like this:

1. The string is joined on the end of the current fragment.
2. Boundary::has_boundary_at is called with the old fragment length to ensure there’s still a boundary between the end of the original fragment and the joined fragment.
3. If there’s no boundary, the delim character is inserted at that location to force a boundary.

The goal of any joining operation is not to merge chunks.

Errors

Returns Error if the intermediate fragment provided is invalid, or if the combination of self and fragment cannot produce a valid result.

If the intermediate fragment is invalid, then the InvalidFormat error kind will be returned, with the byte_offset set to the first invalid character of the intermediate fragment.

If the join operation itself failed, then the FailedJoin error kind is returned, without setting the byte_offset.

Examples

Basic Usage:

let fragment = LowerSnakeFragment::new("snake")?;
let fragment = fragment.join_with("fragment", LowLine)?;
assert_eq!(fragment, "snake_fragment");

pub fn replace<M, F>( &self, from: M, to: F, ) -> Result<FragmentBuf<B, D, P>, Error>

where M: Pattern, F: IntoIntermediate<B, D, P>,

Returns a heap-allocated fragment, replacing the provided pattern with a fragment of the user’s choice.

For from, the pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

For to, this function takes anything that can be represented as an intermediate fragment. That means it can take a &str, char, Fragment, Chunk, Identifier, or Segment.

Errors

Returns Error if the intermediate fragment provided is invalid, or if the replacement of from to to does not produce a valid fragment.

If the intermediate fragment is invalid, then the InvalidFormat error kind will be returned, with the byte_offset set to the first invalid character of the intermediate fragment.

If the replace operation itself failed, then the FailedReplace error kind is returned, without setting the byte_offset.

Examples

Basic Usage:

let fragment = LowerSnakeFragment::new("example_snake_identifier")?;
let fragment = fragment.replace("snake", "serpent")?;
assert_eq!(fragment, "example_serpent_identifier");

pub fn with_circumfix<F1, F2>( &self, prefix: F1, suffix: F2, ) -> Result<FragmentBuf<B, D, P>, Error>

where F1: IntoIntermediate<B, D, P>, F2: IntoIntermediate<B, D, P>,

Returns a heap-allocated fragment with the provided prefix and suffix attached to the original fragment.

The affixes provided to this function takes anything that can be represented as an intermediate fragment. That means it can take a &str, char, Fragment, Chunk, Identifier, or Segment.

Errors

Returns Error if the intermediate fragments provided are invalid, or if the combination of prefix, self, and fragment cannot produce a valid result.

If an intermediate fragment is invalid, then either InvalidPrefix or InvalidSuffix error kind will be returned (depending on which had the format error), with the byte_offset set to the first invalid character of the intermediate fragment.

If the affixing operation itself failed, then the FailedCircumfixing error kind is returned, without setting the byte_offset.

Examples

Basic Usage:

let fragment = LowerSnakeFragment::new("snake")?;
let fragment = fragment.with_circumfix("lower_", "_fragment")?;
assert_eq!(fragment, "lower_snake_fragment");

pub fn with_prefix<F>(&self, prefix: F) -> Result<FragmentBuf<B, D, P>, Error>

where F: IntoIntermediate<B, D, P>,

Returns a heap-allocated fragment with the provided prefix attached to the original fragment.

The prefix provided to this function takes anything that can be represented as an intermediate fragment. That means it can take a &str, char, Fragment, Chunk, Identifier, or Segment.

Errors

Returns Error if the intermediate fragment provided is invalid, or if the combination of prefix and self cannot produce a valid result.

If the intermediate fragment is invalid, then the error kind will be InvalidPrefix, with the byte_offset set to the first invalid character of the intermediate fragment.

If the affixing operation itself failed, then the FailedPrefixing error kind is returned, without setting the byte_offset.

Examples

Basic Usage:

let fragment = LowerSnakeFragment::new("snake")?;
let fragment = fragment.with_prefix("lower_")?;
assert_eq!(fragment, "lower_snake");

pub fn with_suffix<F>(&self, suffix: F) -> Result<FragmentBuf<B, D, P>, Error>

where F: IntoIntermediate<B, D, P>,

Returns a heap-allocated fragment with the provided suffix attached to the original fragment.

The suffix provided to this function takes anything that can be represented as an intermediate fragment. That means it can take a &str, char, Fragment, Chunk, Identifier, or Segment.

Errors

Returns Error if the intermediate fragment provided is invalid, or if the combination of self and suffix cannot produce a valid result.

If the intermediate fragment is invalid, then the error kind will be InvalidSuffix, with the byte_offset set to the first invalid character of the intermediate fragment.

If the affixing operation itself failed, then the FailedSuffixing error kind is returned, without setting the byte_offset.

Examples

Basic Usage:

let fragment = LowerSnakeFragment::new("snake")?;
let fragment = fragment.with_suffix("_fragment")?;
assert_eq!(fragment, "snake_fragment");

pub fn to_boxed_fragment(&self) -> Box<Fragment<B, D, P>>

Converts a fragment into an owned boxed fragment.

Examples

Basic Usage:

let ident: &LowerSnakeFragment = Fragment::new("snake_ident")?;
let ident: Box<LowerSnakeFragment> = ident.to_boxed_fragment();

pub fn to_fragment_buf(&self) -> FragmentBuf<B, D, P>

Converts a fragment into a fragment buffer.

Examples

Basic Usage:

let fragment: &LowerSnakeFragment = Fragment::new("snake_fragment")?;
let buffer: LowerSnakeFragmentBuf = fragment.to_fragment_buf();

pub const EMPTY: &'a Fragment<B, D, P>

pub fn chunked_segments(&self) -> ChunkedSegments<'_, B, D, P>

Produces an iterator over the Segments (chunks and delimiters) of a fragment.

• The Delimiter variant is of type D.
• The Chunk variant is of type Chunk<'_, B, D, P>.

Usually, when breaking into segments, you want to also break chunks into words. However, this iterator will not do that. It simply breaks into broad segments and chunks.

If you want chunk boundaries to be broken, you should instead use the segments function.

Type Erasure

Because segments contain type information specific to the fragment, it can be a little hard to use them in generic situations (where maybe you don’t care about the type information, and just want to see general data about the segments).

In these cases, you should call type_erased to drop type information, mapping to a StrSegment (you can call this on the returned iterator, or on an individual segment).

Examples

Basic Usage:

let flat_ident = CamelIdent::new("HelloWorld_GoodbyeWorld")?;
let mut segments = flat_ident.chunked_segments().type_erased();
assert_eq!(segments.next(), Some(Segment::Chunk("HelloWorld")));
assert_eq!(segments.next(), Some(Segment::Delim('_')));
assert_eq!(segments.next(), Some(Segment::Chunk("GoodbyeWorld")));
assert_eq!(segments.next(), None);

This also works in reverse:

let flat_ident = CamelIdent::new("HelloWorld_GoodbyeWorld")?;
let mut segments = flat_ident.chunked_segments().type_erased();
assert_eq!(segments.next_back(), Some(Segment::Chunk("GoodbyeWorld")));
assert_eq!(segments.next_back(), Some(Segment::Delim('_')));
assert_eq!(segments.next_back(), Some(Segment::Chunk("HelloWorld")));
assert_eq!(segments.next_back(), None);

pub fn chunked_segment_indices(&self) -> ChunkedSegmentIndices<'_, B, D, P>

Produces an iterator over the Segments (chunks and delimiters) of a fragment, and their positions.

• The Delimiter variant is of type D.
• The Chunk variant is of type Chunk<'_, B, D, P>.

Usually, when breaking into segments, you want to also break chunk boundaries. However, this iterator will not do that. It simply breaks into broad segments and chunks.

If you want chunk boundaries to be broken, you should instead use the segment_indices function.

Type Erasure

Because segments contain type information specific to the fragment, it can be a little hard to use them in generic situations (where maybe you don’t care about the type information, and just want to see general data about the segments).

In these cases, you should call type_erased to drop type information, mapping to a StrSegment (you can call this on the returned iterator, or on an individual segment).

Examples

Basic Usage:

let flat_ident = CamelIdent::new("HelloWorld_GoodbyeWorld")?;
let mut segments = flat_ident.chunked_segment_indices().type_erased();
assert_eq!(segments.next(), Some((0, Segment::Chunk("HelloWorld"))));
assert_eq!(segments.next(), Some((10, Segment::Delim('_'))));
assert_eq!(segments.next(), Some((11, Segment::Chunk("GoodbyeWorld"))));
assert_eq!(segments.next(), None);

This also works in reverse:

let flat_ident = CamelIdent::new("HelloWorld_GoodbyeWorld")?;
let mut segments = flat_ident.chunked_segment_indices().type_erased();
assert_eq!(segments.next_back(), Some((11, Segment::Chunk("GoodbyeWorld"))));
assert_eq!(segments.next_back(), Some((10, Segment::Delim('_'))));
assert_eq!(segments.next_back(), Some((0, Segment::Chunk("HelloWorld"))));
assert_eq!(segments.next_back(), None);

pub fn segments(&self) -> Segments<'_, B, D, P>

Produces an iterator over the Segments (chunks and delimiters) of a fragment, with each chunk further sub-divided into words.

• The Delimiter variant is of type D.
• The Chunk variant is of type Chunk<'_, B, D, P>.

This is similar to chunked_segments, except that it will also break chunks based on the configured Boundary type parameter.

See the core module documentation for details on what a word is.

Type Erased

Because segments contain type information specific to the fragment, it can be a little hard to use them in generic situations (where maybe you don’t care about the type information, and just want to see general data about the segments).

In these cases, you should call type_erased to drop type information, mapping to a StrSegment (you can call this on the returned iterator, or on an individual segment).

Examples

Basic Usage:

let flat_ident = CamelIdent::new("HelloWorld_GoodbyeWorld")?;
let mut segments = flat_ident.segments().type_erased();
assert_eq!(segments.next(), Some(Segment::Chunk("Hello")));
assert_eq!(segments.next(), Some(Segment::Chunk("World")));
assert_eq!(segments.next(), Some(Segment::Delim('_')));
assert_eq!(segments.next(), Some(Segment::Chunk("Goodbye")));
assert_eq!(segments.next(), Some(Segment::Chunk("World")));
assert_eq!(segments.next(), None);

These work in reverse as well:

let flat_ident = CamelIdent::new("HelloWorld_GoodbyeWorld")?;
let mut segments = flat_ident.segments().type_erased();
assert_eq!(segments.next_back(), Some(Segment::Chunk("World")));
assert_eq!(segments.next_back(), Some(Segment::Chunk("Goodbye")));
assert_eq!(segments.next_back(), Some(Segment::Delim('_')));
assert_eq!(segments.next_back(), Some(Segment::Chunk("World")));
assert_eq!(segments.next_back(), Some(Segment::Chunk("Hello")));
assert_eq!(segments.next_back(), None);

pub fn segment_indices(&self) -> SegmentIndices<'_, B, D, P>

Produces an iterator over the Segments (chunks and delimiters) of a fragment, with each chunk further sub-divided into words, and their positions.

This is similar to chunked_segment_indices, except that it will also break chunks based on the configured Boundary type parameter.

See the core module documentation for details on what a word is.

Type Erased

Because segments contain type information specific to the fragment, it can be a little hard to use them in generic situations (where maybe you don’t care about the type information, and just want to see general data about the segments).

In these cases, you should call type_erased to drop type information, mapping to a StrSegment (you can call this on the returned iterator, or on an individual segment).

Examples

Basic Usage:

let flat_ident = CamelIdent::new("HelloWorld_GoodbyeWorld")?;
let mut segments = flat_ident.segment_indices().type_erased();
assert_eq!(segments.next(), Some((0, Segment::Chunk("Hello"))));
assert_eq!(segments.next(), Some((5, Segment::Chunk("World"))));
assert_eq!(segments.next(), Some((10, Segment::Delim('_'))));
assert_eq!(segments.next(), Some((11, Segment::Chunk("Goodbye"))));
assert_eq!(segments.next(), Some((18, Segment::Chunk("World"))));
assert_eq!(segments.next(), None);

These work in reverse as well:

let flat_ident = CamelIdent::new("HelloWorld_GoodbyeWorld")?;
let mut segments = flat_ident.segment_indices().type_erased();
assert_eq!(segments.next_back(), Some((18, Segment::Chunk("World"))));
assert_eq!(segments.next_back(), Some((11, Segment::Chunk("Goodbye"))));
assert_eq!(segments.next_back(), Some((10, Segment::Delim('_'))));
assert_eq!(segments.next_back(), Some((5, Segment::Chunk("World"))));
assert_eq!(segments.next_back(), Some((0, Segment::Chunk("Hello"))));
assert_eq!(segments.next_back(), None);

pub fn has_leading_delim(&self) -> bool

Returns true if the fragment has a leading delimiter, false otherwise.

Examples

let fragment = UpperCamelFragment::new("__LeadingDelim")?;
assert!(fragment.has_leading_delim());

let fragment = UpperCamelFragment::new("NoLeadingDelim")?;
assert!(!fragment.has_leading_delim());

pub fn has_trailing_delim(&self) -> bool

Returns true if the fragment has a trailing delimiter, false otherwise.

Examples

let fragment = UpperCamelFragment::new("TrailingDelim__")?;
assert!(fragment.has_trailing_delim());

let fragment = UpperCamelFragment::new("NoTrailingDelim")?;
assert!(!fragment.has_trailing_delim());

pub fn is_anonymous(&self) -> bool

Returns true if the fragment is comprised solely of delimiters, false otherwise.

Examples

let fragment = UpperCamelFragment::new("__NotAnonymous__")?;
assert!(!fragment.is_anonymous());

let fragment = UpperCamelFragment::new("___")?;
assert!(fragment.is_anonymous());

pub fn trim_delims(&self) -> &Self

Trims the leading and trailing delimiters from a fragment.

Examples

let fragment = UpperCamelFragment::new("__SurroundingDelim__")?;
assert_eq!(fragment.trim_delims().as_str(), "SurroundingDelim");

// Note that this can leave you with an empty fragment.
let fragment = UpperCamelFragment::new("____")?;
assert_eq!(fragment.trim_delims().as_str(), "");

pub fn trim_leading_delims(&self) -> &Self

Trims the leading delimiters from a fragment.

Examples

let fragment = UpperCamelFragment::new("__SurroundingDelim__")?;
assert_eq!(fragment.trim_leading_delims().as_str(), "SurroundingDelim__");

// Note that this can leave you with an empty fragment.
let fragment = UpperCamelFragment::new("____")?;
assert_eq!(fragment.trim_leading_delims().as_str(), "");

pub fn trim_trailing_delims(&self) -> &Self

Trims the trailing delimiters from a fragment.

Examples

let fragment = UpperCamelFragment::new("__SurroundingDelim__")?;
assert_eq!(fragment.trim_trailing_delims().as_str(), "__SurroundingDelim");

// Note that this can leave you with an empty fragment.
let fragment = UpperCamelFragment::new("____")?;
assert_eq!(fragment.trim_trailing_delims().as_str(), "");

pub fn as_str(&self) -> &str

Returns a string slice representation of the fragment.

Examples

let fragment = UpperCamelFragment::new("ExampleFragment")?;
assert_eq!(fragment.as_str(), "ExampleFragment");

pub fn contains<M>(&self, pat: M) -> bool

where M: Pattern,

Returns true if the given pattern matches a sub-fragment of this fragment.

Returns false if it does not.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Examples

let fragment = UpperCamelFragment::new("bananas")?;

assert!(fragment.contains("nana"));
assert!(!fragment.contains("apples"));

pub fn ends_with<M>(&self, pat: M) -> bool

where M: Pattern,

Returns true if the given pattern matches a suffix of this fragment.

Returns false if it does not.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Examples

let fragment = UpperCamelFragment::new("bananas")?;

assert!(fragment.ends_with("anas"));
assert!(!fragment.ends_with("nana"));

pub fn starts_with<M>(&self, pat: M) -> bool

where M: Pattern,

Returns true if the given pattern matches a prefix of this fragment.

Returns false if it does not.

The pattern can be a &str, in which case this function will return true if the &str is a prefix of this string slice.

The pattern can also be a char, a slice of chars, or a function or closure that determines if a character matches. These will only be checked against the first character of this fragment. Look at the second example below regarding behavior for slices of chars.

Examples

let fragment = UpperCamelFragment::new("bananas")?;

assert!(fragment.starts_with("bana"));
assert!(!fragment.starts_with("nana"));

let fragment = UpperCamelFragment::new("bananas")?;

// Note that both of these assert successfully.
assert!(fragment.starts_with(&['b', 'a', 'n', 'a']));
assert!(fragment.starts_with(&['a', 'b', 'c', 'd']));

pub fn find<M>(&self, pat: M) -> Option<usize>

where M: Pattern,

Returns the byte index of the first character of this fragment that matches the pattern.

Returns None if the pattern doesn’t match.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Examples

Simple patterns:

let fragment = UpperCamelFragment::new("こんにちはWorld")?;

assert_eq!(fragment.find('こ'), Some(0));
assert_eq!(fragment.find('W'), Some(15));
assert_eq!(fragment.find("orld"), Some(16));

More complex patterns using point-free style and closures:

let fragment = UpperCamelFragment::new("こんにちはWorld")?;

assert_eq!(fragment.find(char::is_alphabetic), Some(0));
assert_eq!(fragment.find(char::is_lowercase), Some(16));
assert_eq!(fragment.find(|c: char| c == 'W' || c == 'w'), Some(15));

Not finding the pattern:

let fragment = UpperCamelFragment::new("こんにちはWorld")?;
let x: &[_] = &['1', '2'];

assert_eq!(fragment.find(x), None);

pub fn rfind<M>(&self, pat: M) -> Option<usize>

where M: Pattern,

Returns the byte index of the first character of this fragment that matches the pattern.

Returns None if the pattern doesn’t match.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Examples

Simple patterns:

let fragment = UpperCamelFragment::new("HelloWorld")?;

assert_eq!(fragment.rfind('o'), Some(6));
assert_eq!(fragment.rfind('H'), Some(0));
assert_eq!(fragment.rfind("lo"), Some(3));

More complex patterns using point-free style and closures:

let fragment = UpperCamelFragment::new("HelloWorld")?;

assert_eq!(fragment.rfind(char::is_uppercase), Some(5));
assert_eq!(fragment.rfind(char::is_lowercase), Some(9));
assert_eq!(fragment.rfind(|c: char| c == 'o' || c == 'e'), Some(6));

Not finding the pattern:

let fragment = UpperCamelFragment::new("HelloWorld")?;
let x: &[_] = &['1', '2'];

assert_eq!(fragment.rfind(x), None);

pub fn cast<B2, D2, P2>(&self) -> &Fragment<B2, D2, P2>

where D: SubsetOf<D2>, P: SubsetOf<P2>,

Zero-cost cast into the type-configured target.

This function does not perform any checks that the format matches the expectations of the target type. The way it’s able to be provided depends on implementation of the SubsetOf trait.

Casting Requirements

This function will be able to be called, if:

• Source::D: SubsetOf<Target::D>, and…
• Source::P: SubsetOf<Target::P>

If these invariants are not upheld, attempting to call this function will result in a compilation failure.

Pro-Tip

If this type can perform a zero-cost cast, then it will also implement AsRef to the target type. Because of this, if you know the shape of target type that you want, but also want to accept the widest range of inputs, you can use an AsRef trait bounds.

fn expect_hybrid<I: AsRef<HybridFragment> + ?Sized>(ident: &I) {}
expect_hybrid(LowerSnakeFragment::new("apple")?);
expect_hybrid(UpperCamelFragment::new("Apple")?);

Examples

Example traversing case profile boundary:

// Compilable Cast:
let original = LowerSnakeFragment::new("apple")?;
let casted: &LowerCamelFragment = original.cast();

// Bad Cast (Fails Compilation):
let original = LowerCamelFragment::new("apple")?;
let casted: &LowerSnakeFragment = original.cast();

Example traversing character profile boundary:

// Compilable Cast:
let original = ascii::LowerSnakeFragment::new("apple")?;
let casted: &unicode::LowerSnakeFragment = original.cast();

// Bad Cast (Fails Compilation):
let original = unicode::LowerSnakeFragment::new("apple")?;
let casted: &ascii::LowerSnakeFragment = original.cast();

Example traversing delimiter boundary:

// Compilable Cast:
let original = LowerSnakeFragment::new("apple")?;
let casted: &HybridFragment = original.cast();

// Bad Cast (Fails Compilation):
let original = HybridFragment::new("apple")?;
let casted: &LowerSnakeFragment = original.cast();

pub fn char_indices(&self) -> CharIndices<'_, B, D, P>

Returns an iterator over the chars of the underlying string slice, and their positions.

This is a special version of the standard-provided CharIndices. It has additional functions on it to allow you to cast the remainder of the string slice back to this type.

Examples

Basic Usage:

let slice = HybridFragment::new("test")?;
let mut chars = slice.char_indices();
assert_eq!(chars.next(), Some((0, 't')));
assert_eq!(chars.next(), Some((1, 'e')));
assert_eq!(chars.next(), Some((2, 's')));
assert_eq!(chars.next(), Some((3, 't')));
assert_eq!(chars.next(), None);

If needed, you can cast the remainder back to this type:

let slice = HybridFragment::new("test")?;
let mut chars = slice.char_indices();
assert_eq!(chars.next(), Some((0, 't')));
assert_eq!(chars.next(), Some((1, 'e')));
let remainder: &HybridFragment = chars.as_fragment();
assert_eq!(remainder, "st");

If you don’t need type information, you can drop it with the type_erased method:

let slice = HybridFragment::new("test")?;
let chars: std::str::CharIndices = slice.char_indices().type_erased();

pub fn chars(&self) -> Chars<'_, B, D, P>

Returns an iterator over the chars of the underlying string slice.

This is a special version of the standard-provided Chars. It has additional functions on it to allow you to cast the remainder of the string slice back to this type.

Examples

Basic Usage:

let slice = HybridFragment::new("test")?;
let mut chars = slice.chars();
assert_eq!(chars.next(), Some('t'));
assert_eq!(chars.next(), Some('e'));
assert_eq!(chars.next(), Some('s'));
assert_eq!(chars.next(), Some('t'));
assert_eq!(chars.next(), None);

If needed, you can cast the remainder back to this type:

let slice = HybridFragment::new("test")?;
let mut chars = slice.chars();
assert_eq!(chars.next(), Some('t'));
assert_eq!(chars.next(), Some('e'));
let remainder: &HybridFragment = chars.as_fragment();
assert_eq!(remainder, "st");

If you don’t need type information, you can drop it with the type_erased method:

let slice = HybridFragment::new("test")?;
let chars: std::str::Chars = slice.chars().type_erased();

pub fn get<I: SliceIndex<Self>>(&self, i: I) -> Option<&Self>

Returns a subslice of a Fragment

This is the non-panicking alternative to using the index operator. Returns None whenever the equivalent indexing operation would panic.

Examples

let slice = HybridFragment::new("こんにちは世界")?;

// indices not on UTF-8 sequence boundaries
assert!(slice.get(1..).is_none());
assert!(slice.get(..20).is_none());

// out of bounds
assert!(slice.get(..42).is_none());

pub unsafe fn get_unchecked<I: SliceIndex<Self>>(&self, i: I) -> &Self

Returns an unchecked subslice of a Fragment

This is the unchecked alternative to using the index operator.

Safety

Callers of this function are responsible that these preconditions are satisfied:

• The starting index must not exceed the ending index;
• Indexes must be within bounds of the original slice;
• Indexes must lie on UTF-8 sequence boundaries.

Failing that, the returned slice may reference invalid memory or violate the invariants communicated by the Fragment type.

Examples

let slice = HybridFragment::new("こんにちは世界")?;
unsafe {
    assert_eq!(slice.get_unchecked(0..15), HybridFragment::new("こんにちは")?);
    assert_eq!(slice.get_unchecked(15..21), HybridFragment::new("世界")?);
}

pub fn is_empty(&self) -> bool

Returns true if self has a length of zero bytes.

Examples

let slice = HybridFragment::new("")?;
assert!(slice.is_empty());

let slice = HybridFragment::new("content")?;
assert!(!slice.is_empty());

pub fn len(&self) -> usize

Returns the length of self.

This length is in bytes, not chars or graphemes. In other words, it might not be what a human considers the length of the subslice.

Examples

let slice = HybridFragment::new("foo")?;
let len = slice.len();
assert_eq!(len, 3);

let slice = HybridFragment::new("ƒoo")?;
assert_eq!(slice.len(), 4); // fancy f!
assert_eq!(slice.chars().count(), 3);

pub fn match_indices<M>(&self, pat: M) -> MatchIndices<'_, B, D, P, M>

where M: Pattern,

Returns an iterator over the disjoint matches of a pattern within the underlying string slice as well as the index that the match starts at.

This is a special version of the standard-provided MatchIndices. Instead of returning regular string slices, it returns Fragment elements.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Iterator behavior

The returned iterator will be a DoubleEndedIterator if the pattern allows a reverse search and forward/reverse search yields the same elements. This is true for, e.g., char, but not for &str.

If the pattern allows a reverse search but its results might differ from a forward search, the rmatch_indices method can be used.

Examples

Basic Usage:

let slice = HybridFragment::new("abcXXXabcYYYabc")?;
let mut matches = slice.match_indices("abc");
assert_eq!(matches.next(), Some((0, HybridFragment::new("abc")?)));
assert_eq!(matches.next(), Some((6, HybridFragment::new("abc")?)));
assert_eq!(matches.next(), Some((12, HybridFragment::new("abc")?)));
assert_eq!(matches.next(), None);

let slice = HybridFragment::new("1abcabc2")?;
let mut matches = slice.match_indices("abc");
assert_eq!(matches.next(), Some((1, HybridFragment::new("abc")?)));
assert_eq!(matches.next(), Some((4, HybridFragment::new("abc")?)));
assert_eq!(matches.next(), None);

let slice = HybridFragment::new("ababa")?;
let mut matches = slice.match_indices("aba");
assert_eq!(matches.next(), Some((0, HybridFragment::new("aba")?)));
assert_eq!(matches.next(), None); // only the first `aba`

If you don’t need type information, you can drop it with the type_erased method. This can be especially useful if you don’t need the typed versions of the results.

let slice = HybridFragment::new("test")?;
let mut matches: std::str::MatchIndices<char> = slice.match_indices('t').type_erased();
assert_eq!(matches.next(), Some((0, "t")));
assert_eq!(matches.next(), Some((3, "t")));
assert_eq!(matches.next(), None);

pub fn matches<M>(&self, pat: M) -> Matches<'_, B, D, P, M>

where M: Pattern,

Returns an iterator over the disjoint matches of a pattern within the underlying string slice.

This is a special version of the standard-provided Matches. Instead of returning regular string slices, it returns Fragment elements.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Iterator behavior

The returned iterator will be a DoubleEndedIterator if the pattern allows a reverse search and forward/reverse search yields the same elements. This is true for, e.g., char, but not for &str.

If the pattern allows a reverse search but its results might differ from a forward search, the rmatches method can be used.

Examples

Basic Usage:

let slice = HybridFragment::new("abcXXXabcYYYabc")?;
let mut matches = slice.matches("abc");
assert_eq!(matches.next(), Some(HybridFragment::new("abc")?));
assert_eq!(matches.next(), Some(HybridFragment::new("abc")?));
assert_eq!(matches.next(), Some(HybridFragment::new("abc")?));
assert_eq!(matches.next(), None);

let slice = HybridFragment::new("1abcabc2")?;
let mut matches = slice.matches("abc");
assert_eq!(matches.next(), Some(HybridFragment::new("abc")?));
assert_eq!(matches.next(), Some(HybridFragment::new("abc")?));
assert_eq!(matches.next(), None);

let slice = HybridFragment::new("ababa")?;
let mut matches = slice.matches("aba");
assert_eq!(matches.next(), Some(HybridFragment::new("aba")?));
assert_eq!(matches.next(), None); // only the first `aba`

If you don’t need type information, you can drop it with the type_erased method. This can be especially useful if you don’t need the typed versions of the results.

let slice = HybridFragment::new("test")?;
let mut matches: std::str::Matches<char> = slice.matches('t').type_erased();
assert_eq!(matches.next(), Some("t"));
assert_eq!(matches.next(), Some("t"));
assert_eq!(matches.next(), None);

pub fn rmatch_indices<M>(&self, pat: M) -> RMatchIndices<'_, B, D, P, M>

where M: Pattern,

Returns an iterator over the disjoint matches of a pattern within the underlying string slice yielded in reverse order, as well as the index that the match starts at

This is a special version of the standard-provided RMatchIndices. Instead of returning regular string slices, it returns Fragment elements.

For matches of pat within self that overlap, only the indices corresponding to the last match are returned.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Iterator behavior

The returned iterator requires that the pattern supports a reverse search, and it will be a DoubleEndedIterator if a forward/reverse search yields the same elements.

For iterating from the front, the match_indices method can be used.

Examples

Basic Usage:

let slice = HybridFragment::new("abcXXXabcYYYabc")?;
let mut matches = slice.rmatch_indices("abc");
assert_eq!(matches.next(), Some((12, HybridFragment::new("abc")?)));
assert_eq!(matches.next(), Some((6, HybridFragment::new("abc")?)));
assert_eq!(matches.next(), Some((0, HybridFragment::new("abc")?)));
assert_eq!(matches.next(), None);

let slice = HybridFragment::new("1abcabc2")?;
let mut matches = slice.rmatch_indices("abc");
assert_eq!(matches.next(), Some((4, HybridFragment::new("abc")?)));
assert_eq!(matches.next(), Some((1, HybridFragment::new("abc")?)));
assert_eq!(matches.next(), None);

let slice = HybridFragment::new("ababa")?;
let mut matches = slice.rmatch_indices("aba");
assert_eq!(matches.next(), Some((2, HybridFragment::new("aba")?)));
assert_eq!(matches.next(), None); // only the first `aba`

If you don’t need type information, you can drop it with the type_erased method. This can be especially useful if you don’t need the typed versions of the results.

let slice = HybridFragment::new("test")?;
let mut matches: std::str::RMatchIndices<char> = slice.rmatch_indices('t').type_erased();
assert_eq!(matches.next(), Some((3, "t")));
assert_eq!(matches.next(), Some((0, "t")));
assert_eq!(matches.next(), None);

pub fn rmatches<M>(&self, pat: M) -> RMatches<'_, B, D, P, M>

where M: Pattern,

Returns an iterator over the disjoint matches of a pattern within the underlying string slice yielded in reverse order.

This is a special version of the standard-provided RMatches. Instead of returning regular string slices, it returns Fragment elements.

For matches of pat within self that overlap, only the indices corresponding to the last match are returned.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Iterator behavior

The returned iterator requires that the pattern supports a reverse search, and it will be a DoubleEndedIterator if a forward/reverse search yields the same elements.

For iterating from the front, the matches method can be used.

Examples

Basic Usage:

let slice = HybridFragment::new("abcXXXabcYYYabc")?;
let mut matches = slice.rmatches("abc");
assert_eq!(matches.next(), Some(HybridFragment::new("abc")?));
assert_eq!(matches.next(), Some(HybridFragment::new("abc")?));
assert_eq!(matches.next(), Some(HybridFragment::new("abc")?));
assert_eq!(matches.next(), None);

let slice = HybridFragment::new("1abcabc2")?;
let mut matches = slice.rmatches("abc");
assert_eq!(matches.next(), Some(HybridFragment::new("abc")?));
assert_eq!(matches.next(), Some(HybridFragment::new("abc")?));
assert_eq!(matches.next(), None);

let slice = HybridFragment::new("ababa")?;
let mut matches = slice.rmatches("aba");
assert_eq!(matches.next(), Some(HybridFragment::new("aba")?));
assert_eq!(matches.next(), None); // only the first `aba`

If you don’t need type information, you can drop it with the type_erased method. This can be especially useful if you don’t need the typed versions of the results.

let slice = HybridFragment::new("test")?;
let mut matches: std::str::RMatches<char> = slice.rmatches('t').type_erased();
assert_eq!(matches.next(), Some("t"));
assert_eq!(matches.next(), Some("t"));
assert_eq!(matches.next(), None);

pub fn split_at(&self, mid: usize) -> (&Self, &Self)

Divides one fragment into two at an index.

The argument, mid, should be a byte offset from the start of the fragment. It must also be on the boundary of a UTF-8 code point.

The two slices returned go from the start of the fragment to mid, and from mid to the end of the fragment.

Panics

Panics if mid is not on a UTF-8 code point boundary, or if it is past the end of the last code point of the fragment. For a non-panicking alternative see split_at_checked.

Examples

let slice = HybridFragment::new("こんにちは世界")?;

let (first, last) = slice.split_at(15);
assert_eq!(first, HybridFragment::new("こんにちは")?);
assert_eq!(last, HybridFragment::new("世界")?);

pub fn split_at_checked(&self, mid: usize) -> Option<(&Self, &Self)>

Divides one fragment into two at an index.

The argument, mid, should be a byte offset from the start of the fragment. It must also be on the boundary of a UTF-8 code point. The method returns None if that’s not the case.

The two slices returned go from the start of the fragment to mid, and from mid to the end of the fragment.

Examples

let slice = HybridFragment::new("こんにちは世界")?;

let (first, last) = slice.split_at_checked(15).unwrap();
assert_eq!(first, HybridFragment::new("こんにちは")?);
assert_eq!(last, HybridFragment::new("世界")?);

assert!(slice.split_at_checked(16).is_none()); // Inside "世"
assert!(slice.split_at_checked(42).is_none()); // Beyond the length

pub fn strip_circumfix<Prefix, Suffix>( &self, prefix: Prefix, suffix: Suffix, ) -> Option<&Self>

where Prefix: Pattern, Suffix: Pattern,

Returns a fragment with the prefix and suffix removed.

If the fragment starts with the pattern prefix and ends with the pattern suffix, and the prefix and suffix don’t overlap, returns the sub-fragment after the prefix and before the suffix, wrapped in Some. Unlike trim_start_matches and trim_end_matches, this method removes both the prefix and suffix exactly once.

If the fragment does not start with prefix, does not end with suffix, or the prefix and suffix overlap, returns None.

Each pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Examples

let slice = HybridFragment::new("FooHelloWorldBar")?;
assert_eq!(slice.strip_circumfix("Foo", "Bar"), Some(HybridFragment::new("HelloWorld")?));
assert_eq!(slice.strip_circumfix("FooHello", "WorldBar"), Some(HybridFragment::new("")?));
assert_eq!(slice.strip_circumfix("Foo", "Foo"), None);
assert_eq!(slice.strip_circumfix("Bar", "Bar"), None);
assert_eq!(slice.strip_circumfix("FooHello", "oWorldBar"), None);

pub fn strip_prefix<M>(&self, prefix: M) -> Option<&Self>

where M: Pattern,

Returns a fragment with the prefix removed.

If the fragment starts with the pattern prefix, returns the sub-fragment after the prefix, wrapped in Some. Unlike trim_start_matches, this method removes the prefix exactly once.

If the fragment does not start with prefix, returns None.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Examples

let slice = HybridFragment::new("HelloWorld")?;
assert_eq!(slice.strip_prefix("Hello"), Some(HybridFragment::new("World")?));
assert_eq!(slice.strip_prefix("HelloWorld"), Some(HybridFragment::new("")?));
assert_eq!(slice.strip_prefix("Goodbye"), None);

pub fn strip_suffix<M>(&self, suffix: M) -> Option<&Self>

where M: Pattern,

Returns a fragment with the suffix removed.

If the fragment ends with the pattern suffix, returns the sub-fragment before the suffix, wrapped in Some. Unlike trim_end_matches, this method removes the suffix exactly once.

If the fragment does not end with suffix, returns None.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Examples

let slice = HybridFragment::new("HelloWorld")?;
assert_eq!(slice.strip_suffix("World"), Some(HybridFragment::new("Hello")?));
assert_eq!(slice.strip_suffix("HelloWorld"), Some(HybridFragment::new("")?));
assert_eq!(slice.strip_suffix("Computer"), None);

pub fn trim_start_matches<M>(&self, pat: M) -> &Self

where M: Pattern,

Returns a fragment with all prefixes that match a pattern repeatedly removed.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Text Directionality

A fragment is a sequence of bytes. start in this context means the first position of that byte string; for a left-to-right language like English or Russian, this will be left side, and for right-to-left languages like Arabic or Hebrew, this will be the right side.

Examples

Simple examples:

let slice = HybridFragment::new("11foo1bar11")?;
assert_eq!(slice.trim_start_matches('1'), HybridFragment::new("foo1bar11")?);

let slice = HybridFragment::new("123foo1bar123")?;
assert_eq!(slice.trim_start_matches(char::is_numeric), HybridFragment::new("foo1bar123")?);

let x: &[_] = &['1', '2'];
let slice = HybridFragment::new("12foo1bar12")?;
assert_eq!(slice.trim_start_matches(x), HybridFragment::new("foo1bar12")?);

// Example with a right-to-left language
let slice = HybridFragment::new("שלוםעולם")?;
assert_eq!(slice.trim_start_matches("שלום"), HybridFragment::new("עולם")?);

A more complex pattern, using a closure:

let slice = HybridFragment::new("1fooX")?;
assert_eq!(slice.trim_start_matches(|c| c == '1' || c == 'X'), HybridFragment::new("fooX")?);

pub fn trim_end_matches<M>(&self, pat: M) -> &Self

where M: Pattern,

Returns a fragment with all suffixes that match a pattern repeatedly removed.

The pattern can be a &str, char, a slice of chars, or a function or closure that determines if a character matches.

Text Directionality

A fragment is a sequence of bytes. end in this context means the last position of that byte string; for a left-to-right language like English or Russian, this will be right side, and for right-to-left languages like Arabic or Hebrew, this will be the left side.

Examples

Simple examples:

let slice = HybridFragment::new("11foo1bar11")?;
assert_eq!(slice.trim_end_matches('1'), HybridFragment::new("11foo1bar")?);

let slice = HybridFragment::new("123foo1bar123")?;
assert_eq!(slice.trim_end_matches(char::is_numeric), HybridFragment::new("123foo1bar")?);

let x: &[_] = &['1', '2'];
let slice = HybridFragment::new("12foo1bar12")?;
assert_eq!(slice.trim_end_matches(x), HybridFragment::new("12foo1bar")?);

// Example with a right-to-left language
let slice = HybridFragment::new("שלוםעולם")?;
assert_eq!(slice.trim_end_matches("עולם"), HybridFragment::new("שלום")?);

A more complex pattern, using a closure:

let slice = HybridFragment::new("1fooX")?;
assert_eq!(slice.trim_end_matches(|c| c == '1' || c == 'X'), HybridFragment::new("1foo")?);

pub fn try_cast<B2, D2, P2>(&self) -> Result<&Fragment<B2, D2, P2>, Error>

where B2: Boundary, D2: Delimiter, P2: CasedProfile,

Attempts a fallible cast into the type-configured target.

You should first attempt to call cast on a type, if that compiles it is preferred to this function (and you will not need to call this), because it is truly zero-cost.

This is equivalent to just calling new on the target type with the current type’s string contents. This function is provided for ergonomic convenience.

Trait Implementations

impl<'a, B1, B2, D1, D2, P1, P2> AsRef<Fragment<B2, D2, P2>> for FragmentBuf<B1, D1, P1>

where D1: Delimiter + SubsetOf<D2>, P1: CasedProfile + SubsetOf<P2>,

fn as_ref(&self) -> &Fragment<B2, D2, P2>

Converts this type into a shared reference of the (usually inferred) input type.

impl<B, D, P> AsRef<[u8]> for FragmentBuf<B, D, P>

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

Converts this type into a shared reference of the (usually inferred) input type.

impl<B, D, P> AsRef<str> for FragmentBuf<B, D, P>

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl<B, D, P> Borrow<Fragment<B, D, P>> for FragmentBuf<B, D, P>

fn borrow(&self) -> &Fragment<B, D, P>

Immutably borrows from an owned value.

impl<B, D, P> Clone for FragmentBuf<B, D, P>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<B, D, P> Debug for FragmentBuf<B, D, P>

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

Formats the value using the given formatter.

impl<B, D, P> Default for FragmentBuf<B, D, P>

fn default() -> Self

Returns the “default value” for a type.

impl<B, D, P> Deref for FragmentBuf<B, D, P>

type Target = Fragment<B, D, P>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<B, D, P> Display for FragmentBuf<B, D, P>

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

Formats the value using the given formatter.

impl<B, D, P> Eq for FragmentBuf<B, D, P>

impl<'a, B, D, P> From<&'a Fragment<B, D, P>> for FragmentBuf<B, D, P>

fn from(orig: &'a Fragment<B, D, P>) -> Self

Converts to this type from the input type.

impl<'a, B, D, P> From<&'a FragmentBuf<B, D, P>> for &'a str

fn from(orig: &'a FragmentBuf<B, D, P>) -> &'a str

Converts to this type from the input type.

impl<B, D, P> From<FragmentBuf<B, D, P>> for String

fn from(orig: FragmentBuf<B, D, P>) -> Self

Converts to this type from the input type.

impl<B, D, P> From<FragmentBuf<B, D, P>> for Box<Fragment<B, D, P>>

fn from(orig: FragmentBuf<B, D, P>) -> Self

Converts to this type from the input type.

impl<B, D, P> From<FragmentBuf<B, D, P>> for Box<str>

fn from(orig: FragmentBuf<B, D, P>) -> Self

Converts to this type from the input type.

impl<B: Boundary, D: Delimiter, P: CasedProfile> FromStr for FragmentBuf<B, D, P>

type Err = Error

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<B, D, P> Hash for FragmentBuf<B, D, P>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<I, B, D, P> Index<I> for FragmentBuf<B, D, P>

where I: SliceIndex<Fragment<B, D, P>>,

type Output = Fragment<B, D, P>

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<B, D, P> Ord for FragmentBuf<B, D, P>

fn cmp(&self, rhs: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl<B, D, P> PartialEq<&str> for FragmentBuf<B, D, P>

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

Equality operator ==.

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

Inequality operator !=.

impl<B1, B2, D1, D2, P1, P2> PartialEq<Chunk<B1, D1, P1>> for FragmentBuf<B2, D2, P2>

fn eq(&self, rhs: &Chunk<B1, D1, P1>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<B1, B2, D1, D2, P1, P2> PartialEq<Fragment<B1, D1, P1>> for FragmentBuf<B2, D2, P2>

fn eq(&self, rhs: &Fragment<B1, D1, P1>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<B1, B2, D1, D2, P1, P2> PartialEq<FragmentBuf<B1, D1, P1>> for FragmentBuf<B2, D2, P2>

fn eq(&self, rhs: &FragmentBuf<B1, D1, P1>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<B1, B2, D1, D2, P1, P2> PartialEq<FragmentBuf<B1, D1, P1>> for Chunk<B2, D2, P2>

fn eq(&self, rhs: &FragmentBuf<B1, D1, P1>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<B1, B2, D1, D2, P1, P2> PartialEq<FragmentBuf<B1, D1, P1>> for Fragment<B2, D2, P2>

fn eq(&self, rhs: &FragmentBuf<B1, D1, P1>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<B1, B2, D1, D2, P1, P2> PartialEq<FragmentBuf<B1, D1, P1>> for Ident<B2, D2, P2>

fn eq(&self, rhs: &FragmentBuf<B1, D1, P1>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<B, D, P> PartialEq<FragmentBuf<B, D, P>> for &str

fn eq(&self, rhs: &FragmentBuf<B, D, P>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'a, B, D, P> PartialEq<FragmentBuf<B, D, P>> for str

fn eq(&self, rhs: &FragmentBuf<B, D, P>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<B, D, P> PartialEq<FragmentBuf<B, D, P>> for String

fn eq(&self, rhs: &FragmentBuf<B, D, P>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<B1, B2, D1, D2, P1, P2> PartialEq<Ident<B1, D1, P1>> for FragmentBuf<B2, D2, P2>

fn eq(&self, rhs: &Ident<B1, D1, P1>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<B, D, P> PartialEq<String> for FragmentBuf<B, D, P>

fn eq(&self, rhs: &String) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<B, D, P> PartialEq<str> for FragmentBuf<B, D, P>

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

Equality operator ==.

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

Inequality operator !=.

impl<B, D, P> PartialOrd<&str> for FragmentBuf<B, D, P>

fn partial_cmp(&self, rhs: &&str) -> 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<B1, B2, D1, D2, P1, P2> PartialOrd<Chunk<B1, D1, P1>> for FragmentBuf<B2, D2, P2>

fn partial_cmp(&self, rhs: &Chunk<B1, D1, P1>) -> 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<B1, B2, D1, D2, P1, P2> PartialOrd<Fragment<B1, D1, P1>> for FragmentBuf<B2, D2, P2>

fn partial_cmp(&self, rhs: &Fragment<B1, D1, P1>) -> 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<B1, B2, D1, D2, P1, P2> PartialOrd<FragmentBuf<B1, D1, P1>> for FragmentBuf<B2, D2, P2>

fn partial_cmp(&self, rhs: &FragmentBuf<B1, D1, P1>) -> 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<B1, B2, D1, D2, P1, P2> PartialOrd<FragmentBuf<B1, D1, P1>> for Chunk<B2, D2, P2>

fn partial_cmp(&self, rhs: &FragmentBuf<B1, D1, P1>) -> 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<B1, B2, D1, D2, P1, P2> PartialOrd<FragmentBuf<B1, D1, P1>> for Fragment<B2, D2, P2>

fn partial_cmp(&self, rhs: &FragmentBuf<B1, D1, P1>) -> 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<B1, B2, D1, D2, P1, P2> PartialOrd<FragmentBuf<B1, D1, P1>> for Ident<B2, D2, P2>

fn partial_cmp(&self, rhs: &FragmentBuf<B1, D1, P1>) -> 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<B, D, P> PartialOrd<FragmentBuf<B, D, P>> for &str

fn partial_cmp(&self, rhs: &FragmentBuf<B, D, P>) -> 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<B, D, P> PartialOrd<FragmentBuf<B, D, P>> for str

fn partial_cmp(&self, rhs: &FragmentBuf<B, D, P>) -> 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<B, D, P> PartialOrd<FragmentBuf<B, D, P>> for String

fn partial_cmp(&self, rhs: &FragmentBuf<B, D, P>) -> 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<B1, B2, D1, D2, P1, P2> PartialOrd<Ident<B1, D1, P1>> for FragmentBuf<B2, D2, P2>

fn partial_cmp(&self, rhs: &Ident<B1, D1, P1>) -> 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<B, D, P> PartialOrd<String> for FragmentBuf<B, D, P>

fn partial_cmp(&self, rhs: &String) -> 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<B, D, P> PartialOrd<str> for FragmentBuf<B, D, P>

fn partial_cmp(&self, rhs: &str) -> 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.