Struct exr::meta::attribute::Text

pub struct Text {
    bytes: TextBytes,
}

A byte array with each byte being a char. This is not UTF an must be constructed from a standard string.

Fields

bytes: TextBytes

Implementations

impl Text

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

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

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

pub fn from_slice_unchecked(text: &TextSlice) -> Self

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

pub fn from_bytes_unchecked(bytes: TextBytes) -> Self

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

pub fn as_slice(&self) -> &TextSlice

The internal ASCII bytes this text is made of.

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

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

pub fn null_terminated_byte_size(&self) -> usize

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

pub fn i32_sized_byte_size(&self) -> usize

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

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

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

fn write_unsized_bytes<W: Write>(bytes: &[u8], write: &mut W) -> UnitResult

Without validation, write this instance to the byte stream.

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

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

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

Read the contents with that length.

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

Write the string contents and a null-terminator.

fn write_null_terminated_bytes<W: Write>( bytes: &[u8], write: &mut W, ) -> UnitResult

Write the string contents and a null-terminator.

pub 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 read_vec_of_i32_sized( read: &mut PeekRead<impl Read>, total_byte_size: usize, ) -> Result<Vec<Text>>

Allows any text length since it is only used for attribute values, but not attribute names, attribute type names, or channel names.

fn write_vec_of_i32_sized_texts<W: Write>( write: &mut W, texts: &[Text], ) -> UnitResult

Allows any text length since it is only used for attribute values, but not attribute names, attribute type names, or channel names.

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

The underlying bytes that represent this text.

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

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

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

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

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

Trait Implementations

impl Borrow<[u8]> for Text

fn borrow(&self) -> &TextSlice

Immutably borrows from an owned value.

impl Clone for Text

fn clone(&self) -> Text

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Text

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

Formats the value using the given formatter.

impl Default for Text

fn default() -> Text

Returns the “default value” for a type.

impl Display for Text

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

Formats the value using the given formatter.

impl<'s> From<&'s str> for Text

fn from(str: &'s str) -> Self

Panics if the string contains an unsupported character

impl Hash for Text

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

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Into<String> for Text

fn into(self) -> String

Converts this type into the (usually inferred) input type.

impl Ord for Text

fn cmp(&self, other: &Text) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq<Text> for str

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<str> for Text

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for Text

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Text

fn partial_cmp(&self, other: &Text) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for Text

impl StructuralPartialEq for Text