Struct pgn_reader::RawHeader

pub struct RawHeader<'a>(pub &'a [u8]);

A header value.

Provides helper methods for decoding backslash escaped values.

A quote inside a string is represented by the backslash immediately followed by a quote. A backslash inside a string is represented by two adjacent backslashes.

Tuple Fields

0: &'a [u8]

Implementations

impl<'a> RawHeader<'a>

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

Returns the raw byte representation of the header value.

pub fn decode(&self) -> Cow<'a, [u8]>

Decodes escaped quotes and backslashes into bytes. Allocates only when the value actually contains escape sequences.

Examples found in repository

src/types.rs (line 185)

    pub fn decode_utf8(&self) -> Result<Cow<'a, str>, Utf8Error> {
        Ok(match self.decode() {
            Cow::Borrowed(borrowed) => Cow::Borrowed(str::from_utf8(borrowed)?),
            Cow::Owned(owned) => Cow::Owned(String::from_utf8(owned).map_err(|e| e.utf8_error())?),
        })
    }

    /// Decodes the header as UTF-8, replacing any invalid byte sequences with
    /// the placeholder � U+FFFD.
    pub fn decode_utf8_lossy(&self) -> Cow<'a, str> {
        match self.decode() {
            Cow::Borrowed(borrowed) => String::from_utf8_lossy(borrowed),
            Cow::Owned(owned) => Cow::Owned(String::from_utf8_lossy(&owned).into_owned()),
        }
    }

pub fn decode_utf8(&self) -> Result<Cow<'a, str>, Utf8Error>

Tries to decode the header as UTF-8. This is guaranteed to succeed on valid PGNs.

Errors

Errors if the header contains an invalid UTF-8 byte sequence.

pub fn decode_utf8_lossy(&self) -> Cow<'a, str>

Decodes the header as UTF-8, replacing any invalid byte sequences with the placeholder � U+FFFD.

Examples found in repository

src/types.rs (line 203)

    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{:?}", self.decode_utf8_lossy())
    }

Trait Implementations

impl<'a> Clone for RawHeader<'a>

fn clone(&self) -> RawHeader<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for RawHeader<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq<RawHeader<'a>> for RawHeader<'a>

fn eq(&self, other: &RawHeader<'a>) -> 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<'a> Eq for RawHeader<'a>

impl<'a> StructuralEq for RawHeader<'a>

impl<'a> StructuralPartialEq for RawHeader<'a>