Struct fafreplay::scfa::ParserBuilder

pub struct ParserBuilder { /* fields omitted */ }

A builder for configuring replay Parsers. See build() for an example.

Methods

impl ParserBuilder

pub fn new() -> ParserBuilder

Initialize with default options

pub fn build(self) -> Parser

Creates a new Parser by moving the internal ParserOptions and consuming self.

Example

use fafreplay::scfa::*;

let parser = ParserBuilder::new()
    .commands(&[
        replay_command::ADVANCE,
        replay_command::VERIFY_CHECKSUM,
        replay_command::END_GAME
    ])
    .build();

pub fn build_clone(&self) -> Parser

Creates a new Parser by cloning the internal ParserOptions. Useful when constructing many parsers with similar options.

Example

use fafreplay::scfa::*;

let mut builder = ParserBuilder::new()
    .commands(&[
        replay_command::ADVANCE,
        replay_command::END_GAME
    ]);

// Can only count game ticks
let tick_parser = builder.build_clone();

let builder = builder.command(replay_command::VERIFY_CHECKSUM);
// Can count game ticks and detect desyncs
let desync_parser = builder.build_clone();

let builder = builder.command(replay_command::LUA_SIM_CALLBACK);
// Can count game ticks, detect desyncs, and extract chat messages
let message_parser = builder.build();

pub fn command(self, command: u8) -> ParserBuilder

Add a command to the ParserOptions.

pub fn commands(self, commands: &[u8]) -> ParserBuilder

Add multiple commands to the ParserOptions.

pub fn commands_all(self) -> ParserBuilder

Add all supported commands to the ParserOptions.

pub fn commands_default(self) -> ParserBuilder

Add the default set of commands to the ParserOptions.

Default commands are ADVANCE, SET_COMMAND_SOURCE, COMMAND_SOURCE_TERMINATED, VERIFY_CHECKSUM, and END_GAME

pub fn limit(self, limit: Option<usize>) -> ParserBuilder

Set a limit on the number of commands to parse. This only applies to commands in the ParserOptions.commands field.

pub fn save_commands(self, save_commands: bool) -> ParserBuilder

Whether or not to store the parsed commands in the parsed ReplayBody. When set to false, Replay.body.commands.len() will always be 0.