Struct exr::meta::attributes::Text

pub struct Text { /* fields omitted */ }

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

Methods

impl Text

Important traits for &'_ mut [u8]

impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]

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

The internal ASCII bytes this text is made of.

pub fn from(str: impl AsRef<str>) -> Option<Self>

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

pub fn from_bytes_unchecked(bytes: SmallVec<[u8; 24]>) -> Self

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

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

Check whether this string is valid, considering the maximum text length.

pub fn validate_bytes(
    text: &[u8],
    null_terminated: bool,
    long_names: Option<bool>
) -> UnitResult

Check whether some bytes are valid, considering the maximum text length.

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.

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.

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.

Trait Implementations

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 Display for Text

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

Formats the value using the given formatter.

impl Eq for Text

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, 

Feeds a slice of this type into the given [Hasher].

impl Into<String> for Text

fn into(self) -> String

Performs the conversion.

impl Ord for Text

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

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<Text> 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: &Text) -> bool

This method tests for !=.

impl PartialOrd<Text> 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: &Text) -> bool

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

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

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

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

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

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

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

impl StructuralEq for Text

impl StructuralPartialEq for Text

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

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &'s str) -> Result<Self, Self::Error>

Performs the conversion.