Struct pgn_reader::BufferedReader
source · [−]pub struct BufferedReader<R> { /* private fields */ }
Expand description
A buffered PGN reader.
Implementations
sourceimpl<T: AsRef<[u8]>> BufferedReader<Cursor<T>>
impl<T: AsRef<[u8]>> BufferedReader<Cursor<T>>
sourcepub fn new_cursor(inner: T) -> 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[..]);
sourceimpl<R: Read> BufferedReader<R>
impl<R: Read> BufferedReader<R>
sourcepub fn new(inner: R) -> 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);
sourcepub fn read_game<V: Visitor>(
&mut self,
visitor: &mut V
) -> Result<Option<V::Result>>
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.
sourcepub fn skip_game<V: Visitor>(&mut self) -> Result<bool>
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.
sourcepub fn into_iter<V: Visitor>(self, visitor: &mut V) -> IntoIter<'_, V, R>ⓘNotable traits for IntoIter<'a, V, R>impl<'a, V: Visitor, R: Read> Iterator for IntoIter<'a, V, R> type Item = Result<V::Result, Error>;
pub fn into_iter<V: Visitor>(self, visitor: &mut V) -> IntoIter<'_, V, R>ⓘNotable traits for IntoIter<'a, V, R>impl<'a, V: Visitor, R: Read> Iterator for IntoIter<'a, V, R> type Item = Result<V::Result, Error>;
Create an iterator over all games.
Errors
- I/O error from the underlying reader.
- Irrecoverable parser errors.
sourcepub fn into_inner(self) -> Chain<Cursor<Buffer>, R>
pub fn into_inner(self) -> Chain<Cursor<Buffer>, R>
Gets the remaining bytes in the buffer and the underlying reader.
Trait Implementations
Auto Trait Implementations
impl<R> RefUnwindSafe for BufferedReader<R> where
R: RefUnwindSafe,
impl<R> Send for BufferedReader<R> where
R: Send,
impl<R> Sync for BufferedReader<R> where
R: Sync,
impl<R> Unpin for BufferedReader<R> where
R: Unpin,
impl<R> UnwindSafe for BufferedReader<R> where
R: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more