Skip to main content

PGNTree

chess_lab::core

Struct PGNTree 

Source 
pub struct PGNTree<T: PartialEq + Clone + Display + Debug> {
    pub event: String,
    pub site: String,
    pub date: String,
    pub round: String,
    pub white: String,
    pub black: String,
    pub result: String,
    pub variant: Option<String>,
    /* private fields */
}
Expand description

A struct representing a PGN tree It contains the game metadata and a list of lines The current line is the move node that is currently being checked

Fields§

§event: String

The event name

§site: String

The site name

§date: String

The date of the game

§round: String

The round number

§white: String

The white player name

§black: String

The black player name

§result: String

The result of the game

§variant: Option<String>

The variant of the game

Implementations§

Source§

impl<T: PartialEq + Clone + Display + Debug> PGNTree<T>

Source

pub fn new( event: String, site: String, date: String, round: String, white: String, black: String, result: String, variant: Option<String>, ) -> PGNTree<T> ⓘ

Creates a new PGNTree with the provided metadata and an empty list of lines

§Arguments
  • event: The event name
  • site: The site name
  • date: The date of the game
  • round: The round number
  • white: The white player name
  • black: The black player name
  • result: The result of the game
  • variant: The variant of the game
  • white_elo: The white player ELO
  • black_elo: The black player ELO
  • time_control: The time control of the game
§Returns

A new PGNTree

§Examples
use chess_lab::core::{PGNTree, Move};

let tree: PGNTree<Move> = PGNTree::new(
   "Event".to_string(),
   "Site".to_string(),
   "Date".to_string(),
   "Round".to_string(),
   "White".to_string(),
   "Black".to_string(),
   "Result".to_string(),
   None,
);
Source

pub fn add_metadata( &mut self, key: &str, value: &str, ) -> Result<(), PGNMetadataError>

Adds metadata to the PGNTree

§Arguments
  • key: The metadata key
  • value: The metadata value
§Returns

A Result<(), PGNMetadataError>

  • Ok(()): If the metadata was added successfully
  • Err(PGNMetadataError): If the metadata key is invalid
§Examples
use chess_lab::core::{PGNTree, Move};

let mut tree: PGNTree<Move> = PGNTree::default();
tree.add_metadata("Event", "My Event").unwrap();
assert_eq!(tree.event, "My Event");
Source

pub fn add_move( &mut self, mov: T, halfmove_clock: u32, fullmove_number: u32, en_passant: Option<Position>, castling_rights: u8, game_status: GameStatus, prev_positions: HashMap<String, u32>, )

Adds a move to the current line

§Arguments
  • mov: The move to add
  • halfmove_clock: The halfmove clock
  • fullmove_number: The fullmove number
  • en_passant: The en passant position
  • castling_rights: The castling rights
  • game_status: The game status
  • prev_positions: The previous positions
§Examples
use chess_lab::core::{PGNTree, Piece, Move, MoveType, PieceType, Color, Position, GameStatus};
use std::collections::HashMap;

let mut pgn_tree: PGNTree<Move> = PGNTree::default();
let mov = Move::new(
    Piece::new(Color::Black, PieceType::Pawn),
    Position::from_string("e2").unwrap(),
    Position::from_string("e4").unwrap(),
    MoveType::Normal {
        capture: false,
        promotion: None,
    },
    None,
    None,
    (false, false),
    false,
    false,
).unwrap();
pgn_tree.add_move(mov.clone(), 0, 0, None, 0, GameStatus::InProgress, HashMap::new());

assert_eq!(mov, pgn_tree.get_move().unwrap());
Source

pub fn rm_move(&mut self)

Removes the current line

§Examples
use chess_lab::core::{PGNTree, Piece, Move, PieceType, MoveType, Color, Position, GameStatus};
use std::collections::HashMap;

let mut tree = PGNTree::default();

tree.add_move(Move::new(
    Piece::new(Color::Black, PieceType::Pawn),
    Position::from_string("e2").unwrap(),
    Position::from_string("e4").unwrap(),
    MoveType::Normal {
        capture: false,
        promotion: None,
    },
    None,
    None,
    (false, false),
    false,
    false,
).unwrap(), 0, 0, None, 0, GameStatus::InProgress, HashMap::new());

tree.rm_move();
Source

pub fn get_move(&self) -> Option<T>

Returns the current move

§Returns

The current move

§Examples
use chess_lab::core::{PGNTree, Piece, Move, PieceType, MoveType, Color, Position, GameStatus};
use std::collections::HashMap;

let mut tree = PGNTree::default();
let mov = Move::new(
    Piece::new(Color::Black, PieceType::Pawn),
    Position::from_string("e2").unwrap(),
    Position::from_string("e4").unwrap(),
    MoveType::Normal {
        capture: false,
        promotion: None,
    },
    None,
    None,
    (false, false),
    false,
    false,
).unwrap();

tree.add_move(mov.clone(), 0, 0, None, 0, GameStatus::InProgress, HashMap::new());

assert_eq!(tree.get_move(), Some(mov));
Source

pub fn get_move_info(&self) -> Option<MoveInfo>

Returns the move info

§Returns

A tuple containing the halfmove clock, the fullmove number, the en passant position and the castling rights

§Examples
use chess_lab::core::{PGNTree, Piece, Move, PieceType, MoveType, Color, Position, GameStatus, MoveInfo};
use std::collections::HashMap;

let mut tree = PGNTree::default();
let mov = Move::new(
    Piece::new(Color::Black, PieceType::Pawn),
    Position::from_string("e2").unwrap(),
    Position::from_string("e4").unwrap(),
    MoveType::Normal {
        capture: false,
        promotion: None,
    },
    None,
    None,
    (false, false),
    false,
    false,
).unwrap();

tree.add_move(mov.clone(), 0, 0, None, 0, GameStatus::InProgress, HashMap::new());

assert_eq!(tree.get_move_info(), Some(MoveInfo::new(0, 0, None, 0, GameStatus::InProgress, HashMap::new())));
Source

pub fn next_move(&mut self) -> Option<T>

Returns the next move

§Returns

The next move

§Examples
use chess_lab::core::{PGNTree, Piece, Move, PieceType, MoveType, Color, Position, GameStatus};
use std::collections::HashMap;

let mut pgn_tree = PGNTree::default();
let mov1 = Move::new(
    Piece::new(Color::Black, PieceType::Pawn),
    Position::from_string("e2").unwrap(),
    Position::from_string("e4").unwrap(),
    MoveType::Normal {
        capture: false,
        promotion: None,
    },
    None,
    None,
    (false, false),
    false,
    false,
).unwrap();
let mov2 = Move::new(
    Piece::new(Color::White, PieceType::Pawn),
    Position::from_string("e7").unwrap(),
    Position::from_string("e5").unwrap(),
    MoveType::Normal {
        capture: false,
        promotion: None,
    },
    None,
    None,
    (false, false),
    false,
    false,
).unwrap();
pgn_tree.add_move(mov1.clone(), 0, 0, None, 0, GameStatus::InProgress, HashMap::new());
pgn_tree.add_move(mov2.clone(), 0, 0, None, 0, GameStatus::InProgress, HashMap::new());

assert_eq!(mov2, pgn_tree.get_move().unwrap());
assert_eq!(mov1, pgn_tree.prev_move().unwrap());
assert_eq!(mov2, pgn_tree.next_move().unwrap());
Source

pub fn next_move_variant(&mut self, variant: u32) -> Option<T>

Returns the next move variant

§Arguments
  • variant: The variant to get
§Returns

The next move variant

§Examples
use chess_lab::core::{PGNTree, Piece, Move, PieceType, MoveType, Color, Position, GameStatus};
use std::collections::HashMap;

let mut pgn_tree = PGNTree::default();
let mov1 = Move::new(
    Piece::new(Color::White, PieceType::Pawn),
    Position::from_string("e2").unwrap(),
    Position::from_string("e4").unwrap(),
    MoveType::Normal {
        capture: false,
        promotion: None,
    },
    None,
    None,
    (false, false),
    false,
    false,
).unwrap();
let mov2 = Move::new(
    Piece::new(Color::White, PieceType::Pawn),
    Position::from_string("d2").unwrap(),
    Position::from_string("d4").unwrap(),
    MoveType::Normal {
        capture: false,
        promotion: None,
    },
    None,
    None,
    (false, false),
    false,
    false,
).unwrap();
pgn_tree.add_move(mov1.clone(), 0, 0, None, 0, GameStatus::InProgress, HashMap::new());
pgn_tree.prev_move();
pgn_tree.add_move(mov2.clone(), 0, 0, None, 0, GameStatus::InProgress, HashMap::new());

pgn_tree.prev_move();
assert_eq!(mov1, pgn_tree.next_move().unwrap());

pgn_tree.prev_move();
assert_eq!(mov2, pgn_tree.next_move_variant(1).unwrap());
Source

pub fn all_next_moves(&self) -> Vec<T>

Returns all the next moves

§Returns

All the next moves

§Example
use chess_lab::core::{PGNTree, Piece, Move, PieceType, MoveType, Color, Position, GameStatus};
use std::collections::HashMap;

let mut pgn_tree = PGNTree::default();
let mov1 = Move::new(
    Piece::new(Color::White, PieceType::Pawn),
    Position::from_string("e4").unwrap(),
    Position::from_string("e2").unwrap(),
    MoveType::Normal {
        capture: false,
        promotion: None,
    },
    None,
    None,
    (false, false),
    false,
    false,
).unwrap();

let mov2 = Move::new(
    Piece::new(Color::White, PieceType::Pawn),
    Position::from_string("d2").unwrap(),
    Position::from_string("d4").unwrap(),
    MoveType::Normal {
        capture: false,
        promotion: None,
    },
    None,
    None,
    (false, false),
    false,
    false,
).unwrap();

pgn_tree.add_move(mov1.clone(), 0, 0, None, 0, GameStatus::InProgress, HashMap::new());
pgn_tree.prev_move();
pgn_tree.add_move(mov2.clone(), 0, 0, None, 0, GameStatus::InProgress, HashMap::new());
pgn_tree.prev_move();

assert_eq!(vec![mov1.clone(), mov2.clone()], pgn_tree.all_next_moves());
Source

pub fn prev_move(&mut self) -> Option<T>

Returns the previous move

§Returns

The previous move

§Examples
use chess_lab::core::{PGNTree, Piece, Move, PieceType, MoveType, Color, Position, GameStatus};
use std::collections::HashMap;

let mut pgn_tree = PGNTree::default();
let mov1 = Move::new(
    Piece::new(Color::Black, PieceType::Pawn),
    Position::from_string("e2").unwrap(),
    Position::from_string("e4").unwrap(),
    MoveType::Normal {
        capture: false,
        promotion: None,
    },
    None,
    None,
    (false, false),
    false,
    false,
). unwrap();
let mov2 = Move::new(
    Piece::new(Color::White, PieceType::Pawn),
    Position::from_string("e7").unwrap(),
    Position::from_string("e5").unwrap(),
    MoveType::Normal {
        capture: false,
        promotion: None,
    },
    None,
    None,
    (false, false),
    false,
    false,
).unwrap();
pgn_tree.add_move(mov1.clone(), 0, 0, None, 0, GameStatus::InProgress, HashMap::new());
pgn_tree.add_move(mov2.clone(), 0, 0, None, 0, GameStatus::InProgress, HashMap::new());

assert_eq!(mov2, pgn_tree.get_move().unwrap());
assert_eq!(mov1, pgn_tree.prev_move().unwrap());
Source

pub fn has_next_move(&self) -> bool

Returns whether there is a next move

§Returns

Whether there is a next move

§Examples
use chess_lab::core::{PGNTree, Piece, Move, PieceType, MoveType, Color, Position, GameStatus};
use std::collections::HashMap;

let mut pgn_tree = PGNTree::default();
let mov1 = Move::new(
    Piece::new(Color::White, PieceType::Pawn),
    Position::from_string("e2").unwrap(),
    Position::from_string("e4").unwrap(),
    MoveType::Normal {
        capture: false,
        promotion: None,
    },
    None,
    None,
    (false, false),
    false,
    false,
).unwrap();
pgn_tree.add_move(mov1.clone(), 0, 0, None, 0, GameStatus::InProgress, HashMap::new());
pgn_tree.prev_move();

assert!(pgn_tree.has_next_move());
Source

pub fn has_prev_move(&self) -> bool

Returns whether there is a previous move

§Returns

Whether there is a previous move

§Examples
use chess_lab::core::{PGNTree, Piece, Move, PieceType, MoveType, Color, Position, GameStatus};
use std::collections::HashMap;

let mut pgn_tree = PGNTree::default();
let mov1 = Move::new(
    Piece::new(Color::White, PieceType::Pawn),
    Position::from_string("e2").unwrap(),
    Position::from_string("e4").unwrap(),
    MoveType::Normal {
        capture: false,
        promotion: None,
    },
    None,
    None,
    (false, false),
    false,
    false,
).unwrap();

pgn_tree.add_move(mov1.clone(), 0, 0, None, 0, GameStatus::InProgress, HashMap::new());
assert!(pgn_tree.has_prev_move());
Source

pub fn pgn(&self) -> String

Returns the PGN of the game

§Returns

The PGN of the game

§Examples
use chess_lab::core::{PGNTree, Piece, Move, PieceType, MoveType, Color, Position, GameStatus};
use std::collections::HashMap;

let mut pgn_tree = PGNTree::default();
let mov1 = Move::new(
    Piece::new(Color::White, PieceType::Pawn),
    Position::from_string("e2").unwrap(),
    Position::from_string("e4").unwrap(),
    MoveType::Normal {
        capture: false,
        promotion: None,
    },
    None,
    None,
    (false, false),
    false,
    false,
).unwrap();
let mov2 = Move::new(
    Piece::new(Color::Black, PieceType::Pawn),
    Position::from_string("e7").unwrap(),
    Position::from_string("e5").unwrap(),
    MoveType::Normal {
        capture: false,
        promotion: None,
    },
    None,
    None,
    (false, false),
    false,
    false,
).unwrap();
pgn_tree.add_move(mov1.clone(), 0, 0, None, 0, GameStatus::InProgress, HashMap::new());
pgn_tree.add_move(mov2.clone(), 0, 0, None, 0, GameStatus::InProgress, HashMap::new());

assert_eq!(pgn_tree.pgn(), "[Event \"\"]\n[Site \"\"]\n[Date \"\"]\n[Round \"\"]\n[White \"\"]\n[Black \"\"]\n[Result \"\"]\n1. e4 e5");
Source

pub fn game_over(&mut self, game_status: GameStatus)

Sets the game result

§Arguments
  • game_status - The game status
§Examples
use chess_lab::core::{PGNTree, Move, GameStatus, WinReason};

let mut pgn_tree: PGNTree<Move> = PGNTree::default();

pgn_tree.game_over(GameStatus::WhiteWins(WinReason::Checkmate));

assert_eq!(pgn_tree.result, "1-0".to_string());

Trait Implementations§

Source§

impl<T: Clone + PartialEq + Clone + Display + Debug> Clone for PGNTree<T>

Source§

fn clone(&self) -> PGNTree<T> ⓘ

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + PartialEq + Clone + Display + Debug> Debug for PGNTree<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: PartialEq + Clone + Display + Debug> Default for PGNTree<T>

Source§

fn default() -> PGNTree<T> ⓘ

Creates a new PGNTree with no metadata and an empty list of lines

§Returns

A an empty PGNTree

§Examples
use chess_lab::core::{PGNTree, Move};

let tree: PGNTree<Move> = PGNTree::default();
Source§

impl<T: PartialEq + Clone + Display + Debug> DoubleEndedIterator for PGNTree<T>

Source§

fn next_back(&mut self) -> Option<Self::Item>

Returns the previous move

§Returns

The previous move

§Examples
use chess_lab::core::{PGNTree, Piece, Move, PieceType, MoveType, Color, Position, GameStatus};
use std::collections::HashMap;

let mut pgn_tree = PGNTree::default();
let mov1 = Move::new(
    Piece::new(Color::Black, PieceType::Pawn),
    Position::from_string("e2").unwrap(),
    Position::from_string("e4").unwrap(),
    MoveType::Normal {
        capture: false,
        promotion: None,
    },
    None,
    None,
    (false, false),
    false,
    false,
).unwrap();
let mov2 = Move::new(
    Piece::new(Color::White, PieceType::Pawn),
    Position::from_string("e7").unwrap(),
    Position::from_string("e5").unwrap(),
    MoveType::Normal {
        capture: false,
        promotion: None,
    },
    None,
    None,
    (false, false),
    false,
    false,
).unwrap();
pgn_tree.add_move(mov1.clone(), 0, 0, None, 0, GameStatus::InProgress, HashMap::new());
pgn_tree.add_move(mov2.clone(), 0, 0, None, 0, GameStatus::InProgress, HashMap::new());

assert_eq!(mov2, pgn_tree.get_move().unwrap());
assert_eq!(mov1, pgn_tree.next_back().unwrap());
Source§

fn advance_back_by(&mut self, n: usize) -> Result<(), NonZero<usize>>

🔬This is a nightly-only experimental API. (iter_advance_by)
Advances the iterator from the back by n elements. Read more
1.37.0 · Source§

fn nth_back(&mut self, n: usize) -> Option<Self::Item>

Returns the nth element from the end of the iterator. Read more
1.27.0 · Source§

fn try_rfold<B, F, R>(&mut self, init: B, f: F) -> R
where Self: Sized, F: FnMut(B, Self::Item) -> R, R: Try<Output = B>,

This is the reverse version of Iterator::try_fold(): it takes elements starting from the back of the iterator. Read more
1.27.0 · Source§

fn rfold<B, F>(self, init: B, f: F) -> B
where Self: Sized, F: FnMut(B, Self::Item) -> B,

An iterator method that reduces the iterator’s elements to a single, final value, starting from the back. Read more
1.27.0 · Source§

fn rfind<P>(&mut self, predicate: P) -> Option<Self::Item>
where Self: Sized, P: FnMut(&Self::Item) -> bool,

Searches for an element of an iterator from the back that satisfies a predicate. Read more
Source§

impl<T: PartialEq + Clone + Display + Debug> Iterator for PGNTree<T>

Source§

fn next(&mut self) -> Option<Self::Item>

Returns the next move

§Returns

The next move

§Examples
use chess_lab::core::{PGNTree, Piece, Move, PieceType, MoveType, Color, Position, GameStatus};
use std::collections::HashMap;

let mut pgn_tree = PGNTree::default();
let mov1 = Move::new(
    Piece::new(Color::Black, PieceType::Pawn),
    Position::from_string("e2").unwrap(),
    Position::from_string("e4").unwrap(),
    MoveType::Normal {
        capture: false,
        promotion: None,
    },
    None,
    None,
    (false, false),
    false,
    false,
).unwrap();
let mov2 = Move::new(
    Piece::new(Color::White, PieceType::Pawn),
    Position::from_string("e7").unwrap(),
    Position::from_string("e5").unwrap(),
    MoveType::Normal {
        capture: false,
        promotion: None,
    },
    None,
    None,
    (false, false),
    false,
    false,
).unwrap();
pgn_tree.add_move(mov1.clone(), 0, 0, None, 0, GameStatus::InProgress, HashMap::new());
pgn_tree.add_move(mov2.clone(), 0, 0, None, 0, GameStatus::InProgress, HashMap::new());

assert_eq!(mov2, pgn_tree.get_move().unwrap());
assert_eq!(mov1, pgn_tree.next_back().unwrap());
assert_eq!(mov2, pgn_tree.next().unwrap());
Source§

type Item = T

The type of the elements being iterated over.
Source§

fn next_chunk<const N: usize>( &mut self, ) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>
where Self: Sized,

🔬This is a nightly-only experimental API. (iter_next_chunk)
Advances the iterator and returns an array containing the next N values. Read more
1.0.0 · Source§

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the iterator. Read more
1.0.0 · Source§

fn count(self) -> usize
where Self: Sized,

Consumes the iterator, counting the number of iterations and returning it. Read more
1.0.0 · Source§

fn last(self) -> Option<Self::Item>
where Self: Sized,

Consumes the iterator, returning the last element. Read more
Source§

fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>>

🔬This is a nightly-only experimental API. (iter_advance_by)
Advances the iterator by n elements. Read more
1.0.0 · Source§

fn nth(&mut self, n: usize) -> Option<Self::Item>

Returns the nth element of the iterator. Read more
1.28.0 · Source§

fn step_by(self, step: usize) -> StepBy<Self>
where Self: Sized,

Creates an iterator starting at the same point, but stepping by the given amount at each iteration. Read more
1.0.0 · Source§

fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter>
where Self: Sized, U: IntoIterator<Item = Self::Item>,

Takes two iterators and creates a new iterator over both in sequence. Read more
1.0.0 · Source§

fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter>
where Self: Sized, U: IntoIterator,

‘Zips up’ two iterators into a single iterator of pairs. Read more
Source§

fn intersperse(self, separator: Self::Item) -> Intersperse<Self>
where Self: Sized, Self::Item: Clone,

🔬This is a nightly-only experimental API. (iter_intersperse)
Creates a new iterator which places a copy of separator between items of the original iterator. Read more
Source§

fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>
where Self: Sized, G: FnMut() -> Self::Item,

🔬This is a nightly-only experimental API. (iter_intersperse)
Creates a new iterator which places an item generated by separator between items of the original iterator. Read more
1.0.0 · Source§

fn map<B, F>(self, f: F) -> Map<Self, F>
where Self: Sized, F: FnMut(Self::Item) -> B,

Takes a closure and creates an iterator which calls that closure on each element. Read more
1.21.0 · Source§

fn for_each<F>(self, f: F)
where Self: Sized, F: FnMut(Self::Item),

Calls a closure on each element of an iterator. Read more
1.0.0 · Source§

fn filter<P>(self, predicate: P) -> Filter<Self, P>
where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator which uses a closure to determine if an element should be yielded. Read more
1.0.0 · Source§

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F>
where Self: Sized, F: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both filters and maps. Read more
1.0.0 · Source§

fn enumerate(self) -> Enumerate<Self>
where Self: Sized,

Creates an iterator which gives the current iteration count as well as the next value. Read more
1.0.0 · Source§

fn peekable(self) -> Peekable<Self>
where Self: Sized,

Creates an iterator which can use the peek and peek_mut methods to look at the next element of the iterator without consuming it. See their documentation for more information. Read more
1.0.0 · Source§

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>
where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator that skips elements based on a predicate. Read more
1.0.0 · Source§

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>
where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator that yields elements based on a predicate. Read more
1.57.0 · Source§

fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P>
where Self: Sized, P: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both yields elements based on a predicate and maps. Read more
1.0.0 · Source§

fn skip(self, n: usize) -> Skip<Self>
where Self: Sized,

Creates an iterator that skips the first n elements. Read more
1.0.0 · Source§

fn take(self, n: usize) -> Take<Self>
where Self: Sized,

Creates an iterator that yields the first n elements, or fewer if the underlying iterator ends sooner. Read more
1.0.0 · Source§

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F>
where Self: Sized, F: FnMut(&mut St, Self::Item) -> Option<B>,

An iterator adapter which, like fold, holds internal state, but unlike fold, produces a new iterator. Read more
1.0.0 · Source§

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>
where Self: Sized, U: IntoIterator, F: FnMut(Self::Item) -> U,

Creates an iterator that works like map, but flattens nested structure. Read more
1.29.0 · Source§

fn flatten(self) -> Flatten<Self>
where Self: Sized, Self::Item: IntoIterator,

Creates an iterator that flattens nested structure. Read more
Source§

fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N>
where Self: Sized, F: FnMut(&[Self::Item; N]) -> R,

🔬This is a nightly-only experimental API. (iter_map_windows)
Calls the given function f for each contiguous window of size N over self and returns an iterator over the outputs of f. Like slice::windows(), the windows during mapping overlap as well. Read more
1.0.0 · Source§

fn fuse(self) -> Fuse<Self>
where Self: Sized,

Creates an iterator which ends after the first None. Read more
1.0.0 · Source§

fn inspect<F>(self, f: F) -> Inspect<Self, F>
where Self: Sized, F: FnMut(&Self::Item),

Does something with each element of an iterator, passing the value on. Read more
1.0.0 · Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adapter for this instance of Iterator. Read more
1.0.0 · Source§

fn collect<B>(self) -> B
where B: FromIterator<Self::Item>, Self: Sized,

Transforms an iterator into a collection. Read more
Source§

fn try_collect<B>( &mut self, ) -> <<Self::Item as Try>::Residual as Residual<B>>::TryType
where Self: Sized, Self::Item: Try, <Self::Item as Try>::Residual: Residual<B>, B: FromIterator<<Self::Item as Try>::Output>,

🔬This is a nightly-only experimental API. (iterator_try_collect)
Fallibly transforms an iterator into a collection, short circuiting if a failure is encountered. Read more
Source§

fn collect_into<E>(self, collection: &mut E) -> &mut E
where E: Extend<Self::Item>, Self: Sized,

🔬This is a nightly-only experimental API. (iter_collect_into)
Collects all the items from an iterator into a collection. Read more
1.0.0 · Source§

fn partition<B, F>(self, f: F) -> (B, B)
where Self: Sized, B: Default + Extend<Self::Item>, F: FnMut(&Self::Item) -> bool,

Consumes an iterator, creating two collections from it. Read more
Source§

fn partition_in_place<'a, T, P>(self, predicate: P) -> usize
where T: 'a, Self: Sized + DoubleEndedIterator<Item = &'a mut T>, P: FnMut(&T) -> bool,

🔬This is a nightly-only experimental API. (iter_partition_in_place)
Reorders the elements of this iterator in-place according to the given predicate, such that all those that return true precede all those that return false. Returns the number of true elements found. Read more
Source§

fn is_partitioned<P>(self, predicate: P) -> bool
where Self: Sized, P: FnMut(Self::Item) -> bool,

🔬This is a nightly-only experimental API. (iter_is_partitioned)
Checks if the elements of this iterator are partitioned according to the given predicate, such that all those that return true precede all those that return false. Read more
1.27.0 · Source§

fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R
where Self: Sized, F: FnMut(B, Self::Item) -> R, R: Try<Output = B>,

An iterator method that applies a function as long as it returns successfully, producing a single, final value. Read more
1.27.0 · Source§

fn try_for_each<F, R>(&mut self, f: F) -> R
where Self: Sized, F: FnMut(Self::Item) -> R, R: Try<Output = ()>,

An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error. Read more
1.0.0 · Source§

fn fold<B, F>(self, init: B, f: F) -> B
where Self: Sized, F: FnMut(B, Self::Item) -> B,

Folds every element into an accumulator by applying an operation, returning the final result. Read more
1.51.0 · Source§

fn reduce<F>(self, f: F) -> Option<Self::Item>
where Self: Sized, F: FnMut(Self::Item, Self::Item) -> Self::Item,

Reduces the elements to a single one, by repeatedly applying a reducing operation. Read more
Source§

fn try_reduce<R>( &mut self, f: impl FnMut(Self::Item, Self::Item) -> R, ) -> <<R as Try>::Residual as Residual<Option<<R as Try>::Output>>>::TryType
where Self: Sized, R: Try<Output = Self::Item>, <R as Try>::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (iterator_try_reduce)
Reduces the elements to a single one by repeatedly applying a reducing operation. If the closure returns a failure, the failure is propagated back to the caller immediately. Read more
1.0.0 · Source§

fn all<F>(&mut self, f: F) -> bool
where Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if every element of the iterator matches a predicate. Read more
1.0.0 · Source§

fn any<F>(&mut self, f: F) -> bool
where Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if any element of the iterator matches a predicate. Read more
1.0.0 · Source§

fn find<P>(&mut self, predicate: P) -> Option<Self::Item>
where Self: Sized, P: FnMut(&Self::Item) -> bool,

Searches for an element of an iterator that satisfies a predicate. Read more
1.30.0 · Source§

fn find_map<B, F>(&mut self, f: F) -> Option<B>
where Self: Sized, F: FnMut(Self::Item) -> Option<B>,

Applies function to the elements of iterator and returns the first non-none result. Read more
Source§

fn try_find<R>( &mut self, f: impl FnMut(&Self::Item) -> R, ) -> <<R as Try>::Residual as Residual<Option<Self::Item>>>::TryType
where Self: Sized, R: Try<Output = bool>, <R as Try>::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (try_find)
Applies function to the elements of iterator and returns the first true result or the first error. Read more
1.0.0 · Source§

fn position<P>(&mut self, predicate: P) -> Option<usize>
where Self: Sized, P: FnMut(Self::Item) -> bool,

Searches for an element in an iterator, returning its index. Read more
1.0.0 · Source§

fn max(self) -> Option<Self::Item>
where Self: Sized, Self::Item: Ord,

Returns the maximum element of an iterator. Read more
1.0.0 · Source§

fn min(self) -> Option<Self::Item>
where Self: Sized, Self::Item: Ord,

Returns the minimum element of an iterator. Read more
1.6.0 · Source§

fn max_by_key<B, F>(self, f: F) -> Option<Self::Item>
where B: Ord, Self: Sized, F: FnMut(&Self::Item) -> B,

Returns the element that gives the maximum value from the specified function. Read more
1.15.0 · Source§

fn max_by<F>(self, compare: F) -> Option<Self::Item>
where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the maximum value with respect to the specified comparison function. Read more
1.6.0 · Source§

fn min_by_key<B, F>(self, f: F) -> Option<Self::Item>
where B: Ord, Self: Sized, F: FnMut(&Self::Item) -> B,

Returns the element that gives the minimum value from the specified function. Read more
1.15.0 · Source§

fn min_by<F>(self, compare: F) -> Option<Self::Item>
where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the minimum value with respect to the specified comparison function. Read more
1.0.0 · Source§

fn rev(self) -> Rev<Self>
where Self: Sized + DoubleEndedIterator,

Reverses an iterator’s direction. Read more
1.0.0 · Source§

fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)
where FromA: Default + Extend<A>, FromB: Default + Extend<B>, Self: Sized + Iterator<Item = (A, B)>,

Converts an iterator of pairs into a pair of containers. Read more
1.36.0 · Source§

fn copied<'a, T>(self) -> Copied<Self>
where T: Copy + 'a, Self: Sized + Iterator<Item = &'a T>,

Creates an iterator which copies all of its elements. Read more
1.0.0 · Source§

fn cloned<'a, T>(self) -> Cloned<Self>
where T: Clone + 'a, Self: Sized + Iterator<Item = &'a T>,

Creates an iterator which clones all of its elements. Read more
1.0.0 · Source§

fn cycle(self) -> Cycle<Self>
where Self: Sized + Clone,

Repeats an iterator endlessly. Read more
Source§

fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N>
where Self: Sized,

🔬This is a nightly-only experimental API. (iter_array_chunks)
Returns an iterator over N elements of the iterator at a time. Read more
1.11.0 · Source§

fn sum<S>(self) -> S
where Self: Sized, S: Sum<Self::Item>,

Sums the elements of an iterator. Read more
1.11.0 · Source§

fn product<P>(self) -> P
where Self: Sized, P: Product<Self::Item>,

Iterates over the entire iterator, multiplying all the elements Read more
1.5.0 · Source§

fn cmp<I>(self, other: I) -> Ordering
where I: IntoIterator<Item = Self::Item>, Self::Item: Ord, Self: Sized,

Lexicographically compares the elements of this Iterator with those of another. Read more
Source§

fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering
where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,

🔬This is a nightly-only experimental API. (iter_order_by)
Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function. Read more
1.5.0 · Source§

fn partial_cmp<I>(self, other: I) -> Option<Ordering>
where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Lexicographically compares the PartialOrd elements of this Iterator with those of another. The comparison works like short-circuit evaluation, returning a result without comparing the remaining elements. As soon as an order can be determined, the evaluation stops and a result is returned. Read more
Source§

fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering>
where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,

🔬This is a nightly-only experimental API. (iter_order_by)
Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function. Read more
1.5.0 · Source§

fn eq<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialEq<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are equal to those of another. Read more
Source§

fn eq_by<I, F>(self, other: I, eq: F) -> bool
where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,

🔬This is a nightly-only experimental API. (iter_order_by)
Determines if the elements of this Iterator are equal to those of another with respect to the specified equality function. Read more
1.5.0 · Source§

fn ne<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialEq<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are not equal to those of another. Read more
1.5.0 · Source§

fn lt<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically less than those of another. Read more
1.5.0 · Source§

fn le<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically less or equal to those of another. Read more
1.5.0 · Source§

fn gt<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically greater than those of another. Read more
1.5.0 · Source§

fn ge<I>(self, other: I) -> bool
where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically greater than or equal to those of another. Read more
1.82.0 · Source§

fn is_sorted(self) -> bool
where Self: Sized, Self::Item: PartialOrd,

Checks if the elements of this iterator are sorted. Read more
1.82.0 · Source§

fn is_sorted_by<F>(self, compare: F) -> bool
where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> bool,

Checks if the elements of this iterator are sorted using the given comparator function. Read more
1.82.0 · Source§

fn is_sorted_by_key<F, K>(self, f: F) -> bool
where Self: Sized, F: FnMut(Self::Item) -> K, K: PartialOrd,

Checks if the elements of this iterator are sorted using the given key extraction function. Read more

Auto Trait Implementations§

§

impl<T> Freeze for PGNTree<T>

§

impl<T> !RefUnwindSafe for PGNTree<T>

§

impl<T> !Send for PGNTree<T>

§

impl<T> !Sync for PGNTree<T>

§

impl<T> Unpin for PGNTree<T>

§

impl<T> UnsafeUnpin for PGNTree<T>

§

impl<T> !UnwindSafe for PGNTree<T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<I> IntoIterator for I
where I: Iterator,

Source§

type Item = <I as Iterator>::Item

The type of the elements being iterated over.
Source§

type IntoIter = I

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> I

Creates an iterator from a value. Read more
Source§

impl<I> IteratorRandom for I
where I: Iterator,

Source§

fn choose<R>(self, rng: &mut R) -> Option<Self::Item>
where R: Rng + ?Sized,

Choose one element at random from the iterator. Read more
Source§

fn choose_stable<R>(self, rng: &mut R) -> Option<Self::Item>
where R: Rng + ?Sized,

Choose one element at random from the iterator. Read more
Source§

fn choose_multiple_fill<R>(self, rng: &mut R, buf: &mut [Self::Item]) -> usize
where R: Rng + ?Sized,

Collects values at random from the iterator into a supplied buffer until that buffer is filled. Read more
Source§

fn choose_multiple<R>(self, rng: &mut R, amount: usize) -> Vec<Self::Item>
where R: Rng + ?Sized,

Collects amount values at random from the iterator into a vector. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V