Struct jomini::TextTape

pub struct TextTape<'a> { /* private fields */ }

Houses the tape of tokens that is extracted from plaintext data

Implementations

impl<'a> TextTape<'a>

pub fn windows1252_reader(&self) -> ObjectReader<'_, '_, Windows1252Encoding>

Creates a windows 1252 object reader from the parsed tape

Examples found in repository

src/text/writer.rs (line 512)

    pub fn write_tape(&mut self, tape: &TextTape) -> Result<(), Error> {
        // it doesn't actually matter the encoding that is chosen as everything
        // will be blindly written out and we don't need to know the encoding
        // for that.
        let reader = tape.windows1252_reader();
        self.write_object_core(reader)?;
        Ok(())
    }

pub fn utf8_reader(&self) -> ObjectReader<'_, '_, Utf8Encoding>

Creates a utf-8 object reader from the parsed tape

impl<'a> TextTape<'a>

pub fn new() -> Self

Creates a new text tape

pub fn from_slice(data: &[u8]) -> Result<TextTape<'_>, Error>

Convenience method for creating a text parser and parsing the given input

Examples found in repository

src/text/de.rs (line 181)

    pub fn from_windows1252_slice<'a, T>(data: &'a [u8]) -> Result<T, Error>
    where
        T: Deserialize<'a>,
    {
        let tape = TextTape::from_slice(data)?;
        TextDeserializer::from_windows1252_tape(&tape)
    }

    /// Deserialize the given text tape assuming quoted strings are windows1252 encoded.
    pub fn from_windows1252_tape<'a, T>(tape: &TextTape<'a>) -> Result<T, Error>
    where
        T: Deserialize<'a>,
    {
        Self::from_encoded_tape(tape, Windows1252Encoding::new())
    }

    /// Convenience method for parsing the given text data and deserializing as utf8 encoded.
    pub fn from_utf8_slice<'a, T>(data: &'a [u8]) -> Result<T, Error>
    where
        T: Deserialize<'a>,
    {
        let tape = TextTape::from_slice(data)?;
        TextDeserializer::from_utf8_tape(&tape)
    }

pub fn parser() -> TextTapeParser

Returns a parser for text data

pub fn tokens(&self) -> &[TextToken<'a>]

Return the parsed tokens

Examples found in repository

src/text/reader.rs (line 541)

    pub fn new(tape: &'tokens TextTape<'data>, encoding: E) -> Self {
        let tokens = tape.tokens();
        ObjectReader {
            tokens,
            end_ind: tokens.len(),
            start_ind: 0,
            encoding,
        }
    }

pub fn utf8_bom(&self) -> bool

Return if there was a UTF8 BOM in the data

Trait Implementations

impl<'a> Debug for TextTape<'a>

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

Formats the value using the given formatter.

impl<'a> Default for TextTape<'a>

fn default() -> TextTape<'a>

Returns the “default value” for a type.