Struct Ident 

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

An immutable, UTF-8 encoded, valid identifier string slice.

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: Profile (a character profile; Ascii, Unicode, etc.)

Character Requirements

This is effectively a special-case of a Fragment. So in addition to the character requirements of that type, this type adds the following additional requirements:

• Non-empty, and…
• Starts with either D::is_ident_start or P::is_ident_start.

Implementations

impl<B: Boundary, D: Delimiter, P: Profile> Ident<B, D, P>

pub fn join( &self, fragment: &Fragment<B, D, P>, ) -> Result<Box<Ident<B, D, P>>, Error>

where D: Default,

Returns a heap-allocated identifier, joined with the original identifier in a way that preserves 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.

This call is identical to join_with with the default delimiter.

It can be a bit cumbersome to use this function in most cases. Instead, if you find it easier to work with string data (or you don’t have any fragments that you’re joining with), you can use join_str.

Errors

Returns Err if the fragment formed from the combination of self and fragment is invalid. If invalid, an Error is returned with the error_kind set to FailedLeftJoin.

The value byte_offset will NOT be set from this function. None of the individual characters are invalid, it’s just that the combination of joining the fragments themselves is invalid.

Examples

Basic Usage:

let ident = LowerSnakeIdent::new("snake")?;
let ident = ident.join(
    LowerSnakeFragment::new("ident")?,
)?;
assert_eq!(ident.as_ref(), "snake_ident");

pub fn join_str(&self, s: &str) -> Result<Box<Ident<B, D, P>>, Error>

where D: Default,

Returns a heap-allocated identifier, joined with the original identifier in a way that preserves chunk boundaries. The provided string is first converted to a fragment before attempting to append it.

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.

This call is identical to join_str_with with the default delimiter.

Errors

Returns Err if the fragment formed from the combination of self and fragment is invalid. If invalid, an Error is returned with the error_kind set to FailedLeftJoin.

The value byte_offset MAY be set on this function. If the joining string contained invalid characters, this will be set to the byte index (from the start of the joining string) that was invalid.

However, if all characters are independently valid, but one side failed to join (because the join itself would make the following character invalid), then byte_offset will be set to None.

Examples

Basic Usage:

let ident = LowerSnakeIdent::new("snake")?;
let ident = ident.join_str("ident")?;
assert_eq!(ident.as_ref(), "snake_ident");

pub fn join_str_with( &self, s: &str, delim: D, ) -> Result<Box<Ident<B, D, P>>, Error>

Returns a heap-allocated identifier, joined with the original identifier in a way that preserves chunk boundaries. The provided string is first converted to a fragment before attempting to append it.

At the end of the operation, the total number of chunked segments present in the identifier 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.

Errors

Returns Err if the fragment formed from the combination of self and fragment is invalid. If invalid, an Error is returned with the error_kind set to InvalidFormat or FailedLeftJoin.

The value byte_offset MAY be set on this function. If the joining string contained invalid characters, this will be set to the byte index (from the start of the joining string) that was invalid.

However, if all characters are independently valid, but one side failed to join (because the join itself would make the following character invalid), then byte_offset will be set to None.

Examples

Basic Usage:

let ident = LowerSnakeIdent::new("snake")?;
let ident = ident.join_str_with("ident", LowLine)?;
assert_eq!(ident.as_ref(), "snake_ident");

pub fn join_with( &self, fragment: &Fragment<B, D, P>, delim: D, ) -> Result<Box<Ident<B, D, P>>, Error>

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

At the end of the operation, the total number of chunked segments present in the identifier 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.

It can be a bit cumbersome to use this function in most cases. Instead, if you find it easier to work with string data (or you don’t have any fragments that you’re joining with), you can use join_str_with.

Errors

Returns Err if the fragment formed from the combination of self and fragment is invalid. If invalid, an Error is returned with the error_kind set to FailedLeftJoin.

The value byte_offset will NOT be set from this function. None of the individual characters are invalid, it’s just that the combination of joining the fragments themselves is invalid.

Examples

Basic Usage:

let ident = LowerSnakeIdent::new("snake")?;
let ident = ident.join_with(
    LowerSnakeFragment::new("ident")?,
    LowLine,
)?;
assert_eq!(ident.as_ref(), "snake_ident");

pub fn new_boxed(string: String) -> Result<Box<Ident<B, D, P>>, Error>

Converts a string into a boxed identifier if its valid.

Examples

Basic Usage:

let ident: Box<LowerSnakeIdent> =
    Ident::new_boxed(String::from("snake_ident"))?;

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

where M: Pattern,

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

It can be a bit cumbersome to use this function in most cases. Instead, if you find it easier to work with string data (or you don’t have any fragments that you’re replacing with), you can use replace_str.

Errors

Returns Err if the fragment formed from the combination of self and to is invalid at any replacement index. If invalid, an Error is returned with the error_kind set to FailedReplaceLeft or FailedReplaceRight (if the replacement succeeded, but the remainder could not be appended).

The value byte_offset WILL be set from this function, and it will be set to the index that caused the failure from the original fragment (self).

Examples

Basic Usage:

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

pub fn replace_str<M>( &self, from: M, to: &str, ) -> Result<IdentBuf<B, D, P>, Error>

where M: Pattern,

Returns a heap-allocated identifier, replacing the provided pattern with a fragment of the user’s choice. The provided string is first converted to a fragment before attempting to append it.

It can be a bit cumbersome to use this function in most cases. Instead, if you find it easier to work with string data (or you don’t have any fragments that you’re replacing with), you can use replace_str.

Errors

Returns Err if the fragment formed from the combination of self and to is invalid at any replacement index. If invalid, an Error is returned with the error_kind set to InvalidFormat if the provided fragment was invalid, or InvalidReplace if the replacement failed.

The value byte_offset WILL be set from this function. On invalid fragment, it will be set to the byte index from the start of the fragment which was invalid. On invalid replacement, it will be set to the byte index that caused the failure from the original fragment (self).

Examples

Basic Usage:

let ident = LowerSnakeIdent::new("example_snake_identifier")?;
let ident = ident.replace_str("snake", "serpent")?;
assert_eq!(ident.as_ident_or_anonymous(), "example_serpent_identifier");

pub fn with_circumfix( &self, prefix: &Fragment<B, D, P>, suffix: &Fragment<B, D, P>, ) -> Result<Box<Ident<B, D, P>>, Error>

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

It can be a bit cumbersome to use this function in most cases. Instead, if you find it easier to work with string data (or you don’t have any fragments that you’re joining with), you can use with_circumfix_str.

Errors

Returns Err if the fragment formed from the combination of prefix, self, and suffix is invalid. If invalid, an Error is returned with the error_kind set either to InvalidPrefix or InvalidSuffix (depending on which has caused the failure).

The value byte_offset will NOT be set from this function. None of the individual characters are invalid, it’s just that the combination of joining the fragments themselves is invalid.

Examples

Basic Usage:

let ident = LowerSnakeIdent::new("snake")?;
let ident = ident.with_circumfix(
    LowerSnakeFragment::new("lower_")?,
    LowerSnakeFragment::new("_ident")?,
)?;
assert_eq!(ident.as_ref(), "lower_snake_ident");

pub fn with_circumfix_str( &self, prefix: &str, suffix: &str, ) -> Result<Box<Ident<B, D, P>>, Error>

Returns a heap-allocated identifier with the provided prefix and suffix strings attached to the original identifier. The provided strings are first converted to fragments before attempting to append them.

Errors

Returns Err if the fragment formed from the combination of prefix, self, and suffix is invalid. If invalid, an Error is returned with the error_kind set either to InvalidPrefix or InvalidSuffix (depending on which has caused the failure).

The value byte_offset MAY be set on this function. If the prefix or suffix strings contained invalid characters, this will be set to the byte index (from the start of either the prefix or suffix, depending on which error_kind was set) that was invalid.

However, if all characters are independently valid, but one side failed to join (because the join itself would make the following character invalid), then byte_offset will be set to None.

Examples

Basic Usage:

let ident = LowerSnakeIdent::new("snake")?;
let ident = ident.with_circumfix_str("lower_", "_ident")?;
assert_eq!(ident.as_ref(), "lower_snake_ident");

pub fn with_prefix( &self, prefix: &Fragment<B, D, P>, ) -> Result<Box<Ident<B, D, P>>, Error>

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

It can be a bit cumbersome to use this function in most cases. Instead, if you find it easier to work with string data (or you don’t have any fragments that you’re joining with), you can use with_prefix_str.

Errors

Returns Err if the fragment formed from the combination of prefix and self is invalid. If invalid, an Error is returned with the error_kind set to InvalidPrefix.

The value byte_offset will NOT be set from this function. None of the individual characters are invalid, it’s just that the combination of joining the fragments themselves is invalid.

Examples

Basic Usage:

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

pub fn with_prefix_str( &self, prefix: &str, ) -> Result<Box<Ident<B, D, P>>, Error>

Returns a heap-allocated identifier with the provided prefix string attached to the original identifier. The provided string is first converted to a fragment before attempting to append it.

Errors

Returns Err if the fragment formed from the combination of prefix and self is invalid. If invalid, an Error is returned with the error_kind set to InvalidPrefix.

The value byte_offset MAY be set on this function. If the prefix string contained invalid characters, this will be set to the byte index (from the start of the prefix string) that was invalid.

However, if all characters are independently valid, but one side failed to join (because the join itself would make the following character invalid), then byte_offset will be set to None.

Examples

Basic Usage:

let ident = LowerSnakeIdent::new("snake")?;
let ident = ident.with_prefix_str("lower_")?;
assert_eq!(ident.as_ref(), "lower_snake");

pub fn with_suffix( &self, suffix: &Fragment<B, D, P>, ) -> Result<Box<Ident<B, D, P>>, Error>

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

It can be a bit cumbersome to use this function in most cases. Instead, if you find it easier to work with string data (or you don’t have any fragments that you’re joining with), you can use with_suffix_str.

Errors

Returns Err if the fragment formed from the combination of self and suffix is invalid. If invalid, an Error is returned with the error_kind set to InvalidPrefix.

The value byte_offset will NOT be set from this function. None of the individual characters are invalid, it’s just that the combination of joining the fragments themselves is invalid.

Examples

Basic Usage:

let ident = LowerSnakeIdent::new("snake")?;
let ident = ident.with_suffix(
    LowerSnakeFragment::new("_ident")?,
)?;
assert_eq!(ident.as_ref(), "snake_ident");

pub fn with_suffix_str( &self, suffix: &str, ) -> Result<Box<Ident<B, D, P>>, Error>

Returns a heap-allocated identifier with the provided suffix string attached to the original identifier. The provided string is first converted to a fragment before attempting to append it.

Errors

Returns Err if the fragment formed from the combination of self and suffix is invalid. If invalid, an Error is returned with the error_kind set to InvalidPrefix.

The value byte_offset MAY be set on this function. If the suffix string contained invalid characters, this will be set to the byte index (from the start of the suffix string) that was invalid.

However, if all characters are independently valid, but one side failed to join (because the join itself would make the following character invalid), then byte_offset will be set to None.

Examples

Basic Usage:

let ident = LowerSnakeIdent::new("snake")?;
let ident = ident.with_suffix_str("_ident")?;
assert_eq!(ident.as_ref(), "snake_ident");

impl<B, D, P> Ident<B, D, P>

pub fn into_boxed_str(self: Box<Ident<B, D, P>>) -> Box<str>

Converts a boxed identifier into a boxed string slice.

Examples

Basic Usage:

let ident: Box<LowerSnakeIdent> =
    Ident::new_boxed(String::from("snake_ident"))?;
let ident: Box<str> = ident.into_boxed_str();

pub fn into_fragment_buf(self: Box<Ident<B, D, P>>) -> FragmentBuf<B, D, P>

Converts a boxed identifier into a fragment buffer.

Examples

Basic Usage:

let ident: Box<LowerSnakeIdent> =
    Ident::new_boxed(String::from("snake_ident"))?;
let buffer: LowerSnakeFragmentBuf = ident.into_fragment_buf();

pub fn into_ident_buf(self: Box<Ident<B, D, P>>) -> IdentBuf<B, D, P>

Converts a boxed identifier into an identifier buffer.

Examples

Basic Usage:

let ident: Box<LowerSnakeIdent> =
    Ident::new_boxed(String::from("snake_ident"))?;
let buffer: LowerSnakeIdentBuf = ident.into_ident_buf();

pub fn into_string(self: Box<Ident<B, D, P>>) -> String

Converts a boxed identifier into a string.

Examples

Basic Usage:

let ident: Box<LowerSnakeIdent> =
    Ident::new_boxed(String::from("snake_ident"))?;
let ident: String = ident.into_string();

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

Converts an identifier into a fragment buffer.

Examples

Basic Usage:

let ident: &LowerSnakeIdent = Ident::new("snake_ident")?;
let buffer: LowerSnakeFragmentBuf = ident.to_fragment_buf();

pub fn to_ident_buf(&self) -> IdentBuf<B, D, P>

Converts an identifier into an identifier buffer.

Examples

Basic Usage:

let ident: &LowerSnakeIdent = Ident::new("snake_ident")?;
let buffer: LowerSnakeIdentBuf = ident.to_ident_buf();

impl<B: 'static, D: UnitDelimiter + 'static, P: 'static> Ident<B, D, P>

pub const ANONYMOUS: &'static Ident<B, D, P>

An anonymous identifier filled with a single unit delimiter.

impl<B: Boundary, D: Delimiter, P: Profile> Ident<B, D, P>

pub fn first_segment(&self) -> Segment<D, &Chunk<B, D, P>>

Returns the first segment of an identifier.

Since an identifier is always non-empty, there’s always at least one available segment. This function will simply return the first segment.

Examples

let ident = UpperCamelIdent::new("UpperCamelIdent")?;
assert_eq!(
    ident.first_segment(),
    UpperCamelSegment::Chunk(UpperCamelChunk::new("Upper")?),
);

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

Converts a fragment to an identifier.

An identifier is made of a fragment, this function converts between the two. Not all fragments are valid identifiers, however. An identifier has additional requirements.

new checks to ensure these are satisfied before the conversion.

Errors

Returns Err if the fragment does not satisfy the character requirements. If an invalid character is found then an Error is returned, with byte_offset set to the byte index for the first invalid character (for this function, this is always 0).

Examples

let fragment = UpperCamelFragment::new("AnUpperCamel_Fragment")?;
let ident = UpperCamelIdent::from_fragment(fragment)?;
assert_eq!(ident, "AnUpperCamel_Fragment");

pub fn last_segment(&self) -> Segment<D, &Chunk<B, D, P>>

Returns the last segment of an identifier.

Since an identifier is always non-empty, there’s always at least one available segment. This function will simply return the last segment.

Examples

let ident = UpperCamelIdent::new("UpperCamelIdent")?;
assert_eq!(
    ident.last_segment(),
    UpperCamelSegment::Chunk(UpperCamelChunk::new("Ident")?),
);

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

Converts a string slice to an identifier.

An identifier is made of a string slice (&str), this function converts between the two. Not all string slices are valid fragments, however. A fragment requires that the characters it is comprised of satisfy certain requirements.

new checks to ensure these are satisfied before the conversion.

Errors

Returns Err if the string slice does not satisfy the character requirements. If an invalid character is found then an Error is returned, with byte_offset set to the byte index for the first invalid character.

Examples

let ident = UpperCamelIdent::new("AnUpperCamel_Identifier")?;
assert_eq!(ident, "AnUpperCamel_Identifier");

pub fn trim_decorative_delims(&self) -> &Self

Trims any decorative delimiters from the identifier.

This function cannot leave you with an invalid identifier, it explicitly only trims delimiters that it considers to be non-essential, or decorative.

If there’s multiple kinds of delimiters, the right-most delimiter will be preserved. This is essentially the same as calling trim_leading_decorative_delims followed by trim_trailing_decorative_delims.

Examples

Basic Usage:

let ident = UpperCamelIdent::new("__DecoratedIdent__")?;
assert_eq!(ident.trim_decorative_delims(), "DecoratedIdent");

Delimiters will be preserved if the following character is not valid at ident-start:

let ident = UpperCamelIdent::new("__2DecoratedIdent__")?;
assert_eq!(ident.trim_decorative_delims(), "_2DecoratedIdent");

A delimiter-only identifier becomes a single-character identifier:

let ident = UpperCamelIdent::new("____")?;
assert_eq!(ident.trim_decorative_delims(), "_");

If there’s multiple allowed delimiters, the right-most is preserved:

assert_eq!(HybridIdent::new("--__")?.trim_decorative_delims(), "_");
assert_eq!(HybridIdent::new("__--")?.trim_decorative_delims(), "-");

pub fn trim_leading_decorative_delims(&self) -> &Self

Trims any leading decorative delimiters from the identifier.

This function can not leave you with an invalid identifier, it explicitly only trims delimiters that it considers to be non-essential, or decorative.

If there’s multiple kinds of delimiters, the right-most delimiter will be preserved (e.g. the trimming happens from left-to-right).

Examples

Basic Usage:

let ident = UpperCamelIdent::new("__DecoratedIdent__")?;
assert_eq!(ident.trim_leading_decorative_delims(), "DecoratedIdent__");

Delimiters will be preserved if the following character is not valid at ident-start:

let ident = UpperCamelIdent::new("__2DecoratedIdent__")?;
assert_eq!(ident.trim_leading_decorative_delims(), "_2DecoratedIdent__");

A delimiter-only identifier becomes a single-character identifier:

let ident = UpperCamelIdent::new("____")?;
assert_eq!(ident.trim_leading_decorative_delims(), "_");

If there’s multiple allowed delimiters, the right-most is preserved:

assert_eq!(HybridIdent::new("--__")?.trim_leading_decorative_delims(), "_");
assert_eq!(HybridIdent::new("__--")?.trim_leading_decorative_delims(), "-");

pub fn trim_trailing_decorative_delims(&self) -> &Self

Trims any trailing decorative delimiters from the identifier.

This function can not leave you with an invalid identifier, it explicitly only trims delimiters that it considers to be non-essential, or decorative.

If there’s multiple kinds of delimiters, the left-most delimiter will be preserved (e.g. the trimming happens from right-to-left).

Examples

Basic Usage:

let ident = UpperCamelIdent::new("__DecoratedIdent__")?;
assert_eq!(ident.trim_trailing_decorative_delims(), "__DecoratedIdent");
let ident = UpperCamelIdent::new("__2DecoratedIdent__")?;
assert_eq!(ident.trim_trailing_decorative_delims(), "__2DecoratedIdent");

A delimiter-only identifier becomes a single-character identifier:

let ident = UpperCamelIdent::new("____")?;
assert_eq!(ident.trim_trailing_decorative_delims(), "_");

If there’s multiple allowed delimiters, the right-most is preserved:

assert_eq!(HybridIdent::new("--__")?.trim_trailing_decorative_delims(), "-");
assert_eq!(HybridIdent::new("__--")?.trim_trailing_decorative_delims(), "_");

impl<B, D, P> Ident<B, D, P>

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

Returns a fragment representation of the identifier.

Examples

let ident = UpperCamelIdent::new("ExampleIdent")?;
assert_eq!(ident.as_fragment(), UpperCamelFragment::new("ExampleIdent")?);

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

Returns a string slice representation of the fragment.

Examples

let ident = UpperCamelIdent::new("ExampleIdent")?;
assert_eq!(ident.as_str(), "ExampleIdent");

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

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

Zero-cost cast into the type-configured identifier.

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 an identifier can perform a zero-cost cast, then the identifier also will implement AsRef to the target identifier. Because of this, if you know the shape of identifier that you want, but also want to accept the widest range of inputs, you can use an AsRef trait bounds.

fn expect_hybrid_ident<I: AsRef<HybridIdent> + ?Sized>(ident: &I) {
    // ...
}
expect_hybrid_ident(LowerSnakeIdent::new("apple")?);
expect_hybrid_ident(UpperCamelIdent::new("Apple")?);

Examples

Example traversing case profile boundary:

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

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

Example traversing character profile boundary:

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

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

Example traversing delimiter boundary:

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

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

pub const 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 identifier.

Examples

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

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

pub const fn split_at(&self, mid: usize) -> (Option<&Self>, &Fragment<B, D, P>)

Divides one identifier at an index, leaving an optional identifier on the left, and a fragment on the right.

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

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

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 identifier. For a non-panicking alternative see split_at_checked.

Examples

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

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

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

pub const fn split_at_checked( &self, mid: usize, ) -> Option<(Option<&Self>, &Fragment<B, D, P>)>

Divides one identifier at an index, leaving an optional identifier on the left, and a fragment on the right.

The argument, mid, should be a byte offset from the start of the identifier. 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 identifier to mid, and from mid to the end of the identifier.

Examples

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

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

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

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

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

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

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 function), 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.

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

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

where D: Default,

Returns a heap-allocated fragment, joined with the original fragment in a way that preserves 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.

This call is identical to join_with with the default delimiter.

It can be a bit cumbersome to use this function in most cases. Instead, if you find it easier to work with string data (or you don’t have any fragments that you’re joining with), you can use join_str.

Errors

Returns Err if the fragment formed from the combination of self and fragment is invalid. If invalid, an Error is returned with the error_kind set to FailedJoinLeft.

The value byte_offset will NOT be set from this function. None of the individual characters are invalid, it’s just that the combination of joining the fragments themselves is invalid.

Examples

Basic Usage:

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

pub fn join_str(&self, s: &str) -> Result<FragmentBuf<B, D, P>, Error>

where D: Default,

Returns a heap-allocated fragment, joined with the original fragment in a way that preserves chunk boundaries. The provided string is first converted to a fragment before attempting to append it.

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.

This call is identical to join_str_with with the default delimiter.

Errors

Returns Err if the fragment formed from the combination of self and fragment is invalid. If invalid, an Error is returned with the error_kind set to FailedJoinLeft.

The value byte_offset MAY be set on this function. If the joining string contained invalid characters, this will be set to the byte index (from the start of the joining string) that was invalid.

However, if all characters are independently valid, but one side failed to join (because the join itself would make the following character invalid), then byte_offset will be set to None.

Examples

Basic Usage:

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

pub fn join_str_with( &self, s: &str, delim: D, ) -> Result<FragmentBuf<B, D, P>, Error>

Returns a heap-allocated fragment, joined with the original fragment in a way that preserves chunk boundaries. The provided string is first converted to a fragment before attempting to append it.

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.

Errors

Returns Err if the fragment formed from the combination of self and fragment is invalid. If invalid, an Error is returned with the error_kind set to InvalidFormat or FailedJoinLeft.

The value byte_offset MAY be set on this function. If the joining string contained invalid characters, this will be set to the byte index (from the start of the joining string) that was invalid.

However, if all characters are independently valid, but one side failed to join (because the join itself would make the following character invalid), then byte_offset will be set to None.

Examples

Basic Usage:

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

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

Returns a heap-allocated fragment, joined with the original fragment in a way that preserves 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.

It can be a bit cumbersome to use this function in most cases. Instead, if you find it easier to work with string data (or you don’t have any fragments that you’re joining with), you can use join_str_with.

Errors

Returns Err if the fragment formed from the combination of self and fragment is invalid. If invalid, an Error is returned with the error_kind set to FailedJoinLeft.

The value byte_offset will NOT be set from this function. None of the individual characters are invalid, it’s just that the combination of joining the fragments themselves is invalid.

Examples

Basic Usage:

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

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

where M: Pattern,

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

It can be a bit cumbersome to use this function in most cases. Instead, if you find it easier to work with string data (or you don’t have any fragments that you’re replacing with), you can use replace_str.

Errors

Returns Err if the fragment formed from the combination of self and to is invalid at any replacement index. If invalid, an Error is returned with the error_kind set to either FailedReplaceLeft (if to was invalid at a specific replacement) or FailedReplaceRight (if to was valid, but the remainder was not valid after to).

The value byte_offset WILL be set from this function, and it will be set to the index that caused the failure from the original fragment (self).

So for FailedReplaceLeft, this is the byte index of the replacement. For FailedReplaceRight, this is the byte index of the residual that failed to join with the replacement.

Examples

Basic Usage:

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

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

where M: Pattern,

Returns a heap-allocated fragment, replacing the provided pattern with a fragment of the user’s choice. The provided string is first converted to a fragment before attempting to append it.

It can be a bit cumbersome to use this function in most cases. Instead, if you find it easier to work with string data (or you don’t have any fragments that you’re replacing with), you can use replace_str.

Errors

Returns Err if the fragment formed from the combination of self and to is invalid at any replacement index. If invalid, an Error is returned with the error_kind set to InvalidFormat if the provided fragment was invalid, or InvalidReplace if the replacement failed.

The value byte_offset WILL be set from this function. On invalid fragment, it will be set to the byte index from the start of the fragment which was invalid. On invalid replacement, it will be set to the byte index that caused the failure from the original fragment (self).

Examples

Basic Usage:

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

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

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

It can be a bit cumbersome to use this function in most cases. Instead, if you find it easier to work with string data (or you don’t have any fragments that you’re joining with), you can use with_circumfix_str.

Errors

Returns Err if the fragment formed from the combination of prefix, self, and suffix is invalid. If invalid, an Error is returned with the error_kind set either to FailedJoinLeft or FailedJoinRight (depending on which side caused the failure).

The value byte_offset will NOT be set from this function. None of the individual characters are invalid, it’s just that the combination of joining the fragments themselves is invalid.

Examples

Basic Usage:

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

pub fn with_circumfix_str( &self, prefix: &str, suffix: &str, ) -> Result<FragmentBuf<B, D, P>, Error>

Returns a heap-allocated fragment with the provided prefix and suffix strings attached to the original fragment. The provided strings are first converted to fragments before attempting to append them.

Errors

Returns Err if the either of the provided fragments are invalid. If one of them is invalid, an Error is returned with the error_kind set to InvalidPrefix or InvalidSuffix depending on which was invalid (prefix takes precedence if both are invalid).

Returns Err if the fragment formed from the combination of prefix, self, and suffix is invalid. If invalid, an Error is returned with the error_kind set either to FailedJoinLeft or FailedJoinRight (depending on which side caused the failure).

The value byte_offset MAY be set on this function. If the prefix or suffix strings contained invalid characters, this will be set to the byte index (from the start of either the prefix or suffix, depending on which error_kind was set) that was invalid.

However, if all characters are independently valid, but one side failed to join (because the join itself would make the following character invalid), then byte_offset will be set to None.

Examples

Basic Usage:

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

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

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

It can be a bit cumbersome to use this function in most cases. Instead, if you find it easier to work with string data (or you don’t have any fragments that you’re joining with), you can use with_prefix_str.

Errors

Returns Err if the fragment formed from the combination of prefix and self is invalid. If invalid, an Error is returned with the error_kind set to InvalidPrefix.

The value byte_offset will NOT be set from this function. None of the individual characters are invalid, it’s just that the combination of joining the fragments themselves is invalid.

Examples

Basic Usage:

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

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

Returns a heap-allocated fragment with the provided prefix string attached to the original fragment. The provided string is first converted to a fragment before attempting to append it.

Errors

Returns Err if the fragment formed from the combination of prefix and self is invalid. If invalid, an Error is returned with the error_kind set to InvalidPrefix.

The value byte_offset MAY be set on this function. If the prefix string contained invalid characters, this will be set to the byte index (from the start of the prefix string) that was invalid.

However, if all characters are independently valid, but one side failed to join (because the join itself would make the following character invalid), then byte_offset will be set to None.

Examples

Basic Usage:

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

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

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

It can be a bit cumbersome to use this function in most cases. Instead, if you find it easier to work with string data (or you don’t have any fragments that you’re joining with), you can use with_suffix_str.

Errors

Returns Err if the fragment formed from the combination of self and suffix is invalid. If invalid, an Error is returned with the error_kind set to InvalidPrefix.

The value byte_offset will NOT be set from this function. None of the individual characters are invalid, it’s just that the combination of joining the fragments themselves is invalid.

Examples

Basic Usage:

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

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

Returns a heap-allocated fragment with the provided suffix string attached to the original fragment. The provided string is first converted to a fragment before attempting to append it.

Errors

Returns Err if the fragment formed from the combination of self and suffix is invalid. If invalid, an Error is returned with the error_kind set to InvalidPrefix.

The value byte_offset MAY be set on this function. If the suffix string contained invalid characters, this will be set to the byte index (from the start of the suffix string) that was invalid.

However, if all characters are independently valid, but one side failed to join (because the join itself would make the following character invalid), then byte_offset will be set to None.

Examples

Basic Usage:

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

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

Converts an identifier into a fragment buffer.

Examples

Basic Usage:

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

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

Produces an iterator over the Segments of a fragment, joining chunks together into one chunk instead of separating based on boundary logic.

• 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 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 Segment</*Delimiter=*/char, /*Chunk=*/&str> (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 of a fragment, and their positions, joining chunks together into one chunk instead of separating based on boundary logic.

• 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 Segment</*Delimiter=*/char, /*Chunk=*/&str> (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 of a fragment.

• 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.

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 Segment</*Delimiter=*/char, /*Chunk=*/&str> (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 of a fragment, and their positions.

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

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 Segment</*Delimiter=*/char, /*Chunk=*/&str> (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: Profile,

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<B: Boundary, D: Delimiter, P: Profile> AsLowerCamel for Ident<B, D, P>

fn as_lower_camel_canonical_opts<O: Options>(&self) -> LowerCamelCanonical<'_>

Returns a displayable type that converts the provided input to lower camel in canonical form, over some provided boundary options.

fn as_lower_camel_decorated_opts<O: Options>(&self) -> LowerCamelDecorated<'_>

Returns a displayable type that converts the provided input to lower camel in decorated form, over some provided boundary options.

fn as_lower_camel_delimited_opts<O: Options>(&self) -> LowerCamelDelimited<'_>

Returns a displayable type that converts the provided input to lower camel in delimited form, over some provided boundary options.

fn as_lower_camel_canonical(&self) -> LowerCamelCanonical<'_>

Returns a displayable type that converts the provided input to lower camel in canonical form.

fn as_lower_camel_decorated(&self) -> LowerCamelDecorated<'_>

Returns a displayable type that converts the provided input to lower camel in decorated form.

fn as_lower_camel_delimited(&self) -> LowerCamelDelimited<'_>

Returns a displayable type that converts the provided input to lower camel in delimited form.

impl<B: Boundary, D: Delimiter, P: Profile> AsLowerHybrid for Ident<B, D, P>

fn as_lower_hybrid_canonical_opts<O: Options>( &self, default_delim: AsciiFlatLine, ) -> LowerHybridCanonical<'_>

Returns a displayable type that converts the provided input to lower hybrid in canonical form, over some provided boundary options.

fn as_lower_hybrid_decorated_opts<O: Options>( &self, default_delim: AsciiFlatLine, ) -> LowerHybridDecorated<'_>

Returns a displayable type that converts the provided input to lower hybrid in decorated form, over some provided boundary options.

fn as_lower_hybrid_delimited_opts<O: Options>( &self, default_delim: AsciiFlatLine, ) -> LowerHybridDelimited<'_>

Returns a displayable type that converts the provided input to lower hybrid in delimited form, over some provided boundary options.

fn as_lower_hybrid_canonical( &self, default_delim: AsciiFlatLine, ) -> LowerHybridCanonical<'_>

Returns a displayable type that converts the provided input to lower hybrid in canonical form.

fn as_lower_hybrid_decorated( &self, default_delim: AsciiFlatLine, ) -> LowerHybridDecorated<'_>

Returns a displayable type that converts the provided input to lower hybrid in decorated form.

fn as_lower_hybrid_delimited( &self, default_delim: AsciiFlatLine, ) -> LowerHybridDelimited<'_>

Returns a displayable type that converts the provided input to lower hybrid in delimited form.

impl<B: Boundary, D: Delimiter, P: Profile> AsLowerKebab for Ident<B, D, P>

fn as_lower_kebab_canonical(&self) -> LowerKebabCanonical<'_>

Returns a displayable type that converts the provided input to lower kebab in canonical form.

fn as_lower_kebab_decorated(&self) -> LowerKebabDecorated<'_>

Returns a displayable type that converts the provided input to lower kebab in decorated form.

impl<B: Boundary, D: Delimiter, P: Profile> AsLowerSnake for Ident<B, D, P>

fn as_lower_snake_canonical(&self) -> LowerSnakeCanonical<'_>

Returns a displayable type that converts the provided input to lower snake in canonical form.

fn as_lower_snake_decorated(&self) -> LowerSnakeDecorated<'_>

Returns a displayable type that converts the provided input to lower snake in decorated form.

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

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

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

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

impl<B1: Boundary, D1, P1, B2, D2, P2> AsRef<Ident<B2, D2, P2>> for Ident<B1, D1, P1>

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

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

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

impl<B, D, P> AsRef<[u8]> for Ident<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 Ident<B, D, P>

fn as_ref(&self) -> &str

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

impl<B: Boundary, D: Delimiter, P: Profile> AsUpperCamel for Ident<B, D, P>

fn as_upper_camel_canonical_opts<O: Options>(&self) -> UpperCamelCanonical<'_>

Returns a displayable type that converts the provided input to upper camel in canonical form, over some provided boundary options.

fn as_upper_camel_decorated_opts<O: Options>(&self) -> UpperCamelDecorated<'_>

Returns a displayable type that converts the provided input to upper camel in decorated form, over some provided boundary options.

fn as_upper_camel_delimited_opts<O: Options>(&self) -> UpperCamelDelimited<'_>

Returns a displayable type that converts the provided input to upper camel in delimited form, over some provided boundary options.

fn as_upper_camel_canonical(&self) -> UpperCamelCanonical<'_>

Returns a displayable type that converts the provided input to upper camel in canonical form.

fn as_upper_camel_decorated(&self) -> UpperCamelDecorated<'_>

Returns a displayable type that converts the provided input to upper camel in decorated form.

fn as_upper_camel_delimited(&self) -> UpperCamelDelimited<'_>

Returns a displayable type that converts the provided input to upper camel in delimited form.

impl<B: Boundary, D: Delimiter, P: Profile> AsUpperHybrid for Ident<B, D, P>

fn as_upper_hybrid_canonical_opts<O: Options>( &self, default_delim: AsciiFlatLine, ) -> UpperHybridCanonical<'_>

Returns a displayable type that converts the provided input to upper hybrid in canonical form, over some provided boundary options.

fn as_upper_hybrid_decorated_opts<O: Options>( &self, default_delim: AsciiFlatLine, ) -> UpperHybridDecorated<'_>

Returns a displayable type that converts the provided input to upper hybrid in decorated form, over some provided boundary options.

fn as_upper_hybrid_delimited_opts<O: Options>( &self, default_delim: AsciiFlatLine, ) -> UpperHybridDelimited<'_>

Returns a displayable type that converts the provided input to upper hybrid in delimited form, over some provided boundary options.

fn as_upper_hybrid_canonical( &self, default_delim: AsciiFlatLine, ) -> UpperHybridCanonical<'_>

Returns a displayable type that converts the provided input to upper hybrid in canonical form.

fn as_upper_hybrid_decorated( &self, default_delim: AsciiFlatLine, ) -> UpperHybridDecorated<'_>

Returns a displayable type that converts the provided input to upper hybrid in decorated form.

fn as_upper_hybrid_delimited( &self, default_delim: AsciiFlatLine, ) -> UpperHybridDelimited<'_>

Returns a displayable type that converts the provided input to upper hybrid in delimited form.

impl<B: Boundary, D: Delimiter, P: Profile> AsUpperKebab for Ident<B, D, P>

fn as_upper_kebab_canonical(&self) -> UpperKebabCanonical<'_>

Returns a displayable type that converts the provided input to upper kebab in canonical form.

fn as_upper_kebab_decorated(&self) -> UpperKebabDecorated<'_>

Returns a displayable type that converts the provided input to upper kebab in decorated form.

impl<B: Boundary, D: Delimiter, P: Profile> AsUpperSnake for Ident<B, D, P>

fn as_upper_snake_canonical(&self) -> UpperSnakeCanonical<'_>

Returns a displayable type that converts the provided input to upper snake in canonical form.

fn as_upper_snake_decorated(&self) -> UpperSnakeDecorated<'_>

Returns a displayable type that converts the provided input to upper snake in decorated form.

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

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

Formats the value using the given formatter.

impl<B, D, P> Deref for Ident<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 Ident<B, D, P>

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

Formats the value using the given formatter.

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

impl<'a, B, D, P> From<&'a Ident<B, D, P>> for IdentBuf<B, D, P>

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<B, D, P> Hash for Ident<B, D, P>

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

where H: Hasher,

Feeds this value into the given Hasher.

impl<B: Boundary, D: Delimiter, P: Profile> Identifier for Ident<B, D, P>

type Boundary = B

The boundary configuration in-use by this identifier.

type Delimiter = D

The valid delimiters that are allowed by this identifier.

type Profile = P

The character profile that is allowed by this identifier.

fn as_ident(&self) -> &Ident<Self::Boundary, Self::Delimiter, Self::Profile>

Converts to an actual typed identifier.

fn from_fragment( fragment: &Fragment<Self::Boundary, Self::Delimiter, Self::Profile>, ) -> Result<&Ident<Self::Boundary, Self::Delimiter, Self::Profile>, Error>

Converts a fragment to an identifier.

fn new( s: &str, ) -> Result<&Ident<Self::Boundary, Self::Delimiter, Self::Profile>, Error>

Converts a string slice to an identifier.

fn new_boxed( s: String, ) -> Result<Box<Ident<Self::Boundary, Self::Delimiter, Self::Profile>>, Error>

Converts an allocated string to a boxed identifier.

fn new_fragment_buffer() -> FragmentBuf<Self::Boundary, Self::Delimiter, Self::Profile>

Constructs a new ident buffer for this type.

fn new_ident_buffer() -> IdentBuf<Self::Boundary, Self::Delimiter, Self::Profile>

Constructs a new ident buffer for this type.

fn as_fragment( &self, ) -> &Fragment<Self::Boundary, Self::Delimiter, Self::Profile>

Casts the identifier to a fragment.

fn first_segment( &self, ) -> Segment<Self::Delimiter, &Chunk<Self::Boundary, Self::Delimiter, Self::Profile>>

Returns the first segment from an identifier

fn last_segment( &self, ) -> Segment<Self::Delimiter, &Chunk<Self::Boundary, Self::Delimiter, Self::Profile>>

Returns the last segment from an identifier

fn split_at( &self, mid: usize, ) -> (Option<&Ident<Self::Boundary, Self::Delimiter, Self::Profile>>, &Fragment<Self::Boundary, Self::Delimiter, Self::Profile>)

Splits an identifier into fragments at the given index.

fn split_at_checked( &self, mid: usize, ) -> Option<(Option<&Ident<Self::Boundary, Self::Delimiter, Self::Profile>>, &Fragment<Self::Boundary, Self::Delimiter, Self::Profile>)>

Splits an identifier into fragments at the given index (checked variant).

fn trim_decorative_delims( &self, ) -> &Ident<Self::Boundary, Self::Delimiter, Self::Profile>

Trims the decorative (non-required) delimiters from the ends of an identifier.

fn trim_leading_decorative_delims( &self, ) -> &Ident<Self::Boundary, Self::Delimiter, Self::Profile>

Trims the decorative (non-required) delimiters from the start of an identifier.

fn trim_trailing_decorative_delims( &self, ) -> &Ident<Self::Boundary, Self::Delimiter, Self::Profile>

Trims the decorative (non-required) delimiters from the end of an identifier.

fn trim_delims( &self, ) -> &Fragment<Self::Boundary, Self::Delimiter, Self::Profile>

Trims the delimiters from the ends of an identifier.

fn trim_leading_delims( &self, ) -> &Fragment<Self::Boundary, Self::Delimiter, Self::Profile>

Trims the delimiters from the start of an identifier.

fn trim_trailing_delims( &self, ) -> &Fragment<Self::Boundary, Self::Delimiter, Self::Profile>

Trims the delimiters from the end of an identifier.

fn has_leading_delim(&self) -> bool

Returns whether the identifier has leading delimiters.

fn has_trailing_delim(&self) -> bool

Returns whether the identifier has trailing delimiters.

fn is_anonymous(&self) -> bool

Returns whether the identifier consists of only delimiters.

fn as_str(&self) -> &str

Returns the string representation of an identifier.

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

where M: Pattern,

Returns whether the identifier contains a pattern.

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

where M: Pattern,

Returns whether the identifier ends with a pattern.

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

where M: Pattern,

Returns whether the identifier starts with a pattern.

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

where M: Pattern,

Returns the position where a pattern can first be found.

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

where M: Pattern,

Returns the position where a pattern can first be found from the end.

fn chunked_segments( &self, ) -> ChunkedSegments<'_, Self::Boundary, Self::Delimiter, Self::Profile>

Returns an iterator for chunked segments of an identifier.

fn chunked_segment_indices( &self, ) -> ChunkedSegmentIndices<'_, Self::Boundary, Self::Delimiter, Self::Profile>

Returns an iterator for chunked segments of an identifier with their positions.

fn segments( &self, ) -> Segments<'_, Self::Boundary, Self::Delimiter, Self::Profile>

Returns an iterator for segments of an identifier.

fn segment_indices( &self, ) -> SegmentIndices<'_, Self::Boundary, Self::Delimiter, Self::Profile>

Returns an iterator for segments of an identifier with their positions.

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

where Self::Delimiter: SubsetOf<D2>, Self::Profile: SubsetOf<P2>,

Zero-cost casts an identifier to another compatible format.

fn char_indices( &self, ) -> CharIndices<'_, Self::Boundary, Self::Delimiter, Self::Profile>

Returns an iterator over the characters of an identifier and their positions.

fn chars(&self) -> Chars<'_, Self::Boundary, Self::Delimiter, Self::Profile>

Returns an iterator over the characters of an identifier.

fn match_indices<M>( &self, pat: M, ) -> MatchIndices<'_, Self::Boundary, Self::Delimiter, Self::Profile, M>

where M: Pattern,

Returns an iterator over the matches of an identifier and their positions.

fn matches<M>( &self, pat: M, ) -> Matches<'_, Self::Boundary, Self::Delimiter, Self::Profile, M>

where M: Pattern,

Returns an iterator over the matches of an identifier.

fn rmatch_indices<M>( &self, pat: M, ) -> RMatchIndices<'_, Self::Boundary, Self::Delimiter, Self::Profile, M>

where M: Pattern,

Returns an iterator over the matches of an identifier from the end, and their positions.

fn rmatches<M>( &self, pat: M, ) -> RMatches<'_, Self::Boundary, Self::Delimiter, Self::Profile, M>

where M: Pattern,

Returns an iterator over the matches of an identifier from the end.

fn trim_start_matches<M>( &self, pat: M, ) -> &Fragment<Self::Boundary, Self::Delimiter, Self::Profile>

where M: Pattern,

Trims the characters that match the provided pattern from the start.

fn trim_end_matches<M>( &self, pat: M, ) -> &Fragment<Self::Boundary, Self::Delimiter, Self::Profile>

where M: Pattern,

Trims the characters that match the provided pattern from the end.

fn get<I: SliceIndex<Fragment<Self::Boundary, Self::Delimiter, Self::Profile>>>( &self, i: I, ) -> Option<&Fragment<Self::Boundary, Self::Delimiter, Self::Profile>>

Returns a subslice of an identifier.

unsafe fn get_unchecked<I: SliceIndex<Fragment<Self::Boundary, Self::Delimiter, Self::Profile>>>( &self, i: I, ) -> &Fragment<Self::Boundary, Self::Delimiter, Self::Profile>

Returns an unchecked subslice of an identifier.

fn len(&self) -> usize

Returns the length of the identifier.

fn strip_circumfix<Prefix, Suffix>( &self, prefix: Prefix, suffix: Suffix, ) -> Option<&Fragment<Self::Boundary, Self::Delimiter, Self::Profile>>

where Prefix: Pattern, Suffix: Pattern,

Strips the circumfix off an identifier.

fn strip_prefix<M>( &self, prefix: M, ) -> Option<&Fragment<Self::Boundary, Self::Delimiter, Self::Profile>>

where M: Pattern,

Strips the prefix off an identifier.

fn strip_suffix<M>( &self, suffix: M, ) -> Option<&Fragment<Self::Boundary, Self::Delimiter, Self::Profile>>

where M: Pattern,

Strips the suffix off an identifier.

impl<I, B, D, P> Index<I> for Ident<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 Ident<B, D, P>

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

This method returns an Ordering between self and other.

impl<B1, B2, D1, D2, P1, P2> PartialEq<Chunk<B1, D1, P1>> for Ident<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 Ident<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 Ident<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<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<B1, B2, D1, D2, P1, P2> PartialEq<Ident<B1, D1, P1>> for IdentBuf<B2, D2, P2>

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

Equality operator ==.

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

Inequality operator !=.

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

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

Equality operator ==.

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

Inequality operator !=.

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

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

Equality operator ==.

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

Inequality operator !=.

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

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

Equality operator ==.

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

Inequality operator !=.

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

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

Equality operator ==.

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

Inequality operator !=.

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

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

Equality operator ==.

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

Inequality operator !=.

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

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

Equality operator ==.

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

Inequality operator !=.

impl<B, D, P> PartialEq<String> for Ident<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 Ident<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> PartialOrd<Chunk<B1, D1, P1>> for Ident<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 Ident<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 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<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<B1, B2, D1, D2, P1, P2> PartialOrd<Ident<B1, D1, P1>> for IdentBuf<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<B1, B2, D1, D2, P1, P2> PartialOrd<Ident<B1, D1, P1>> for Ident<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<B1, B2, D1, D2, P1, P2> PartialOrd<Ident<B1, D1, P1>> for Chunk<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<B1, B2, D1, D2, P1, P2> PartialOrd<Ident<B1, D1, P1>> for Fragment<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<Ident<B, D, P>> for str

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

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

fn partial_cmp(&self, rhs: &IdentBuf<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 Ident<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 Ident<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<B: Boundary, D: Delimiter, P: Profile> ToLowerCamel for Ident<B, D, P>

fn to_lower_camel_canonical_opts<O: Options>(&self) -> String

Returns a displayable type that converts the provided input to lower camel in canonical form, over some provided boundary options.

fn to_lower_camel_decorated_opts<O: Options>(&self) -> String

Returns a displayable type that converts the provided input to lower camel in decorated form, over some provided boundary options.

fn to_lower_camel_delimited_opts<O: Options>(&self) -> String

Returns a displayable type that converts the provided input to lower camel in delimited form, over some provided boundary options.

fn to_lower_camel_canonical(&self) -> String

Returns a displayable type that converts the provided input to lower camel in canonical form.

fn to_lower_camel_decorated(&self) -> String

Returns a displayable type that converts the provided input to lower camel in decorated form.

fn to_lower_camel_delimited(&self) -> String

Returns a displayable type that converts the provided input to lower camel in delimited form.

impl<B: Boundary, D: Delimiter, P: Profile> ToLowerHybrid for Ident<B, D, P>

fn to_lower_hybrid_canonical_opts<O: Options>( &self, default_delim: AsciiFlatLine, ) -> String

Returns a displayable type that converts the provided input to lower hybrid in canonical form, over some provided boundary options.

fn to_lower_hybrid_decorated_opts<O: Options>( &self, default_delim: AsciiFlatLine, ) -> String

Returns a displayable type that converts the provided input to lower hybrid in decorated form, over some provided boundary options.

fn to_lower_hybrid_delimited_opts<O: Options>( &self, default_delim: AsciiFlatLine, ) -> String

Returns a displayable type that converts the provided input to lower hybrid in delimited form, over some provided boundary options.

fn to_lower_hybrid_canonical(&self, default_delim: AsciiFlatLine) -> String

Returns a displayable type that converts the provided input to lower hybrid in canonical form.

fn to_lower_hybrid_decorated(&self, default_delim: AsciiFlatLine) -> String

Returns a displayable type that converts the provided input to lower hybrid in decorated form.

fn to_lower_hybrid_delimited(&self, default_delim: AsciiFlatLine) -> String

Returns a displayable type that converts the provided input to lower hybrid in delimited form.

impl<B: Boundary, D: Delimiter, P: Profile> ToLowerKebab for Ident<B, D, P>

fn to_lower_kebab_canonical(&self) -> String

Returns a displayable type that converts the provided input to lower kebab in canonical form.

fn to_lower_kebab_decorated(&self) -> String

Returns a displayable type that converts the provided input to lower kebab in decorated form.

impl<B: Boundary, D: Delimiter, P: Profile> ToLowerSnake for Ident<B, D, P>

fn to_lower_snake_canonical(&self) -> String

Returns a displayable type that converts the provided input to lower snake in canonical form.

fn to_lower_snake_decorated(&self) -> String

Returns a displayable type that converts the provided input to lower snake in decorated form.

impl<B, D, P> ToOwned for Ident<B, D, P>

type Owned = Box<Ident<B, D, P>>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl<B: Boundary, D: Delimiter, P: Profile> ToUpperCamel for Ident<B, D, P>

fn to_upper_camel_canonical_opts<O: Options>(&self) -> String

Returns a displayable type that converts the provided input to upper camel in canonical form, over some provided boundary options.

fn to_upper_camel_decorated_opts<O: Options>(&self) -> String

Returns a displayable type that converts the provided input to upper camel in decorated form, over some provided boundary options.

fn to_upper_camel_delimited_opts<O: Options>(&self) -> String

Returns a displayable type that converts the provided input to upper camel in delimited form, over some provided boundary options.

fn to_upper_camel_canonical(&self) -> String

Returns a displayable type that converts the provided input to upper camel in canonical form.

fn to_upper_camel_decorated(&self) -> String

Returns a displayable type that converts the provided input to upper camel in decorated form.

fn to_upper_camel_delimited(&self) -> String

Returns a displayable type that converts the provided input to upper camel in delimited form.

impl<B: Boundary, D: Delimiter, P: Profile> ToUpperHybrid for Ident<B, D, P>

fn to_upper_hybrid_canonical_opts<O: Options>( &self, default_delim: AsciiFlatLine, ) -> String

Returns a displayable type that converts the provided input to upper hybrid in canonical form, over some provided boundary options.

fn to_upper_hybrid_decorated_opts<O: Options>( &self, default_delim: AsciiFlatLine, ) -> String

Returns a displayable type that converts the provided input to upper hybrid in decorated form, over some provided boundary options.

fn to_upper_hybrid_delimited_opts<O: Options>( &self, default_delim: AsciiFlatLine, ) -> String

Returns a displayable type that converts the provided input to upper hybrid in delimited form, over some provided boundary options.

fn to_upper_hybrid_canonical(&self, default_delim: AsciiFlatLine) -> String

Returns a displayable type that converts the provided input to upper hybrid in canonical form.

fn to_upper_hybrid_decorated(&self, default_delim: AsciiFlatLine) -> String

Returns a displayable type that converts the provided input to upper hybrid in decorated form.

fn to_upper_hybrid_delimited(&self, default_delim: AsciiFlatLine) -> String

Returns a displayable type that converts the provided input to upper hybrid in delimited form.

impl<B: Boundary, D: Delimiter, P: Profile> ToUpperKebab for Ident<B, D, P>

fn to_upper_kebab_canonical(&self) -> String

Returns a displayable type that converts the provided input to upper kebab in canonical form.

fn to_upper_kebab_decorated(&self) -> String

Returns a displayable type that converts the provided input to upper kebab in decorated form.

impl<B: Boundary, D: Delimiter, P: Profile> ToUpperSnake for Ident<B, D, P>

fn to_upper_snake_canonical(&self) -> String

Returns a displayable type that converts the provided input to upper snake in canonical form.

fn to_upper_snake_decorated(&self) -> String

Returns a displayable type that converts the provided input to upper snake in decorated form.

impl<'a, B: Boundary, D: Delimiter, P: Profile> TryFrom<&'a Chunk<B, D, P>> for &'a Ident<B, D, P>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(orig: &'a Chunk<B, D, P>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, B: Boundary, D: Delimiter, P: Profile> TryFrom<&'a Fragment<B, D, P>> for &'a Ident<B, D, P>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a, B: Boundary, D: Delimiter, P: Profile> TryFrom<&'a str> for &'a Ident<B, D, P>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(orig: &'a str) -> Result<Self, Self::Error>

Performs the conversion.