Struct StrData 

pub struct StrData { /* private fields */ }

Implementations

impl StrData

pub unsafe fn new_str_unchecked(data: Box<Wtf8>, kind: StrKind) -> Self

Safety

Given bytes must be valid data for given kind

pub unsafe fn new_with_char_len( data: Box<Wtf8>, kind: StrKind, char_len: usize, ) -> Self

Safety

char_len must be accurate.

pub const fn as_wtf8(&self) -> &Wtf8

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

pub fn as_ascii(&self) -> Option<&AsciiStr>

pub const fn kind(&self) -> StrKind

pub fn as_str_kind(&self) -> PyKindStr<'_>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn char_len(&self) -> usize

pub fn char_index_to_byte(&self, index: usize) -> usize

The byte offset the index-th code point starts at.

An index at or past the end answers the buffer’s byte length, so a caller walking to a bound does not have to special-case it.

O(1), but the first call on a non-ASCII string builds an index over the whole buffer, so a caller that resolves a single index and stops is better served by Self::nth_char.

pub fn char_range_to_bytes(&self, range: Range<usize>) -> Range<usize>

The byte range spanned by the code points in range, whose end must not exceed the string’s code point count.

A range that reaches within [MAX_WALK_TO_INDEX] of both ends is walked to for the same reason a single index near one end is – a slice like s[1:-1] should not build a table over the whole string.

pub fn byte_to_char_index(&self, bytepos: usize) -> usize

The character index of the character starting at byte offset bytepos, the inverse of Self::char_index_to_byte.

bytepos must be a character boundary at or before the end.

Logarithmic rather than constant, because the index is keyed the other way – but a search whose bounds came from char_index_to_byte has the table already, and this is what turns a byte offset back into the answer a caller asked for in characters.

pub fn nth_char(&self, index: usize) -> CodePoint

Trait Implementations

impl CharLen for StrData

fn char_len(&self) -> usize

Returns the number of characters in the text

impl Clone for StrData

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StrData

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

Formats the value using the given formatter.

impl Default for StrData

fn default() -> Self

Returns the “default value” for a type.

impl Display for StrData

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

Formats the value using the given formatter.

impl From<AsciiChar> for StrData

fn from(ch: AsciiChar) -> Self

Converts to this type from the input type.

impl From<Box<AsciiStr>> for StrData

fn from(value: Box<AsciiStr>) -> Self

Converts to this type from the input type.

impl From<Box<Wtf8>> for StrData

fn from(value: Box<Wtf8>) -> Self

Converts to this type from the input type.

impl From<Box<str>> for StrData

fn from(value: Box<str>) -> Self

Converts to this type from the input type.

impl From<CodePoint> for StrData

fn from(ch: CodePoint) -> Self

Converts to this type from the input type.

impl From<char> for StrData

fn from(ch: char) -> Self

Converts to this type from the input type.