#chess #pgn

pgn-reader

Fast non-allocating and streaming reader for chess games in PGN notation

8 breaking releases

0.9.0 Jul 29, 2018
0.7.0 Jun 5, 2018
0.5.0 Mar 15, 2018
0.3.0 Nov 4, 2017

#6 in Games

Download history 10/week @ 2018-08-28 10/week @ 2018-09-04 13/week @ 2018-09-11 11/week @ 2018-09-18 2/week @ 2018-09-25 37/week @ 2018-10-02 8/week @ 2018-10-09 135/week @ 2018-10-16 14/week @ 2018-10-23 72/week @ 2018-11-06 38/week @ 2018-11-13

126 downloads per month

GPL-3.0+

62KB
715 lines

pgn-reader

A fast non-allocating and streaming reader for chess games in PGN notation, as a Rust library.

Build Status crates.io docs.rs

Introduction

Reader parses games and calls methods of a user provided Visitor. Implementing custom visitors allows for maximum flexibility:

  • The reader itself does not allocate (besides a single fixed-size buffer). The visitor can decide if and how to represent games in memory.
  • The reader does not validate move legality. This allows implementing support for custom chess variants, or delaying move validation.
  • The visitor can signal to the reader that it does not care about a game or variation.

Example

A visitor that counts the number of syntactically valid moves in the mainline of each game.

extern crate pgn_reader;

use std::io;
use pgn_reader::{Visitor, Skip, BufferedReader, SanPlus};

struct MoveCounter {
    moves: usize,
}

impl MoveCounter {
    fn new() -> MoveCounter {
        MoveCounter { moves: 0 }
    }
}

impl Visitor for MoveCounter {
    type Result = usize;

    fn begin_game(&mut self) {
        self.moves = 0;
    }

    fn san(&mut self, _san_plus: SanPlus) {
        self.moves += 1;
    }

    fn begin_variation(&mut self) -> Skip {
        Skip(true) // stay in the mainline
    }

    fn end_game(&mut self) -> Self::Result {
        self.moves
    }
}

fn main() -> io::Result<()> {
    let pgn = b"1. e4 e5 2. Nf3 (2. f4)
                { game paused due to bad weather }
                2... Nf6 *";

    let mut reader = BufferedReader::new_cursor(&pgn[..]);

    let mut counter = MoveCounter::new();
    let moves = reader.read_game(&mut counter)?;

    assert_eq!(moves, Some(4));
    Ok(())
}

Documentation

Read the documentation

Benchmarks

Run with lichess_db_standard_rated_2014-07.pgn (1,048,440 games, 1048 MB uncompressed) on an SSD, Intel i7-5500U CPU @ 2.40GHz.

Benchmark Time Throughput
examples/stats.rs 5.4s 194.1 MB/s
examples/validate.rs 12.2s 85.9 MB/s
examples/parallel_validate.rs 10.7s 97.9 MB/s
scoutfish make 10.9s 96.1 MB/s
grep -F "[Event " -c 1.1s 952.7 MB/s

License

pgn-reader is licensed under the GPL-3.0 (or any later version at your option). See the COPYING file for the full license text.

Dependencies

~1.5MB
~22K SLoC