Struct Reader 

pub struct Reader<R> { /* private fields */ }

Reads a PGN and calls Visitor methods.

Buffers the underlying reader with an appropriate strategy, so it’s not recommended to add an additional layer of buffering like BufReader.

Implementations

impl<R: Read> Reader<R>

pub fn new(reader: R) -> Reader<R>

Create a reader with default settings based on the PGN standard.

pub fn build(reader: R) -> ReaderBuilder<R>

Build a reader with custom settings.

use std::fs::File;
use pgn_reader::Reader;

let reader = Reader::build(File::open("example.pgn")?)
    .set_supported_tag_line_length(1000)
    .set_supported_comment_length(4000)
    .finish();

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

Read a single game, if any, and return 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 has_more(&mut self) -> Result<bool>

Returns whether the reader has another game to parse, but does not actually parse it.

Errors

• I/O error from the underlying reader.
• Irrecoverable parser errors (while trying to read previous unfinished game to completion).

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

Skip a single game, if any.

Returns Ok(true) if a game found and skipped.

Errors

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

pub fn read_games<'a, V: Visitor>( &'a mut self, visitor: &'a mut V, ) -> ReadGames<'a, R, V>

Iterate over all games, yielding the visitor outputs.

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

Visit all games, ignoring the visitor outputs.

Errors

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

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

The currently buffered bytes.

pub fn into_inner(self) -> R

Discard the remaining bytes in the buffer (Reader::buffer()) and get the underlying reader.

Trait Implementations

impl<R: Clone> Clone for Reader<R>

fn clone(&self) -> Reader<R>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<R: Debug> Debug for Reader<R>

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

Formats the value using the given formatter.

impl<R: Seek> Seek for Reader<R>

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.

fn seek_relative(&mut self, offset: i64) -> Result<()>

Seeks relative to the current position.

fn stream_position(&mut self) -> Result<u64>

Returns the current seek position from the start of the stream.

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream.

fn stream_len(&mut self) -> Result<u64, Error>

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

Returns the length of this stream (in bytes).