Struct Text

impl Text

fn new_or_none(string: impl AsRef<str>) -> Option<Self>

Create a Text from an str reference. Returns None if this string contains unsupported chars.

fn new_or_panic(string: impl AsRef<str>) -> Self

Create a Text from an str reference. Panics if this string contains unsupported chars.

fn from_slice_unchecked(text: &TextSlice) -> Self

Create a Text from a slice of bytes, without checking any of the bytes.

const fn from_bytes_unchecked(bytes: TextBytes) -> Self

Create a Text from the specified bytes object, without checking any of the bytes.

fn as_slice(&self) -> &TextSlice

The internal ASCII bytes this text is made of.

fn validate(&self, null_terminated: bool, long_names: Option<&mut bool>) -> UnitResult

Check whether this string is valid, adjusting long_names if required. If long_names is not provided, text length will be entirely unchecked.

fn validate_bytes(text: &TextSlice, null_terminated: bool, long_names: Option<&mut bool>) -> UnitResult

Check whether some bytes are valid, adjusting long_names if required. If long_names is not provided, text length will be entirely unchecked.

fn null_terminated_byte_size(&self) -> usize

The byte count this string would occupy if it were encoded as a null-terminated string.

fn i32_sized_byte_size(&self) -> usize

The byte count this string would occupy if it were encoded as a size-prefixed string.

fn u32_sized_byte_size(&self) -> usize

The byte count this string would occupy if it were encoded as a size-prefixed string.

fn write_i32_sized_le<W: Write>(&self, write: &mut W) -> UnitResult

Write the length of a string and then the contents with that length.

fn write_u32_sized_le<W: Write>(&self, write: &mut W) -> UnitResult

Write the length of a string and then the contents with that length.

fn read_i32_sized_le<R: Read>(read: &mut R, max_size: usize) -> Result<Self>

Read the length of a string and then the contents with that length.

fn read_u32_sized_le<R: Read>(read: &mut R, max_size: usize) -> Result<Self>

Read the length of a string and then the contents with that length.

fn read_sized<R: Read>(read: &mut R, size: usize) -> Result<Self>

Read the contents with that length.

fn write_null_terminated<W: Write>(&self, write: &mut W) -> UnitResult

Write the string contents and a null-terminator.

fn read_null_terminated<R: Read>(read: &mut R, max_len: usize) -> Result<Self>

Read a string until the null-terminator is found. Then skips the null-terminator.

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

The underlying bytes that represent this text.

fn chars(&self) -> impl '_ + Iterator<Item = char>

Iterate over the individual chars in this text, similar to String::chars(). Does not do any heap-allocation but borrows from this instance instead.

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

Compare this exr::Text with a plain &str.

fn eq_case_insensitive(&self, string: &str) -> bool

Compare this exr::Text with a plain &str ignoring capitalization.