Struct pgn_reader::BufferedReader

pub struct BufferedReader<R> { /* fields omitted */ }

A buffered PGN reader.

Implementations

impl<T: AsRef<[u8]>> BufferedReader<Cursor<T>>

pub fn new_cursor(inner: T) -> BufferedReader<Cursor<T>>

Create a new reader by wrapping a byte slice in a Cursor.

use pgn_reader::BufferedReader;

let pgn = b"1. e4 e5 *";
let reader = BufferedReader::new_cursor(&pgn[..]);

impl<R: Read> BufferedReader<R>

pub fn new(inner: R) -> BufferedReader<R>

Create a new buffered PGN reader.

use std::fs::File;
use pgn_reader::BufferedReader;

let file = File::open("example.pgn")?;
let reader = BufferedReader::new(file);

pub fn read_game<V: Visitor>(
    &mut self,
    visitor: &mut V
) -> Result<Option<V::Result>>

Read a single game, if any, and returns the result produced by the visitor. Returns Ok(None) if the underlying reader is empty.

Errors

• I/O error from the underlying reader.
• Irrecoverable parser errors.

pub fn skip_game<V: Visitor>(&mut self) -> Result<bool>

Skip a single game, if any.

Errors

• I/O error from the underlying reader.
• Irrecoverable parser errors.

pub fn read_all<V: Visitor>(&mut self, visitor: &mut V) -> Result<()>

Read all games.

Errors

• I/O error from the underlying reader.
• Irrecoverable parser errors.

pub fn into_iter<V: Visitor>(self, visitor: &mut V) -> IntoIter<'_, V, R>

Create an iterator over all games.

Errors

• I/O error from the underlying reader.
• Irrecoverable parser errors.

pub fn into_inner(self) -> Chain<Cursor<Buffer>, R>

Gets the remaining bytes in the buffer and the underlying reader.

Trait Implementations

impl<R: Debug> Debug for BufferedReader<R>

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

Formats the value using the given formatter.