Enum boxcars::CrcCheck

pub enum CrcCheck {
    Always,
    Never,
    OnError,
}

Determines under what circumstances the parser should perform the crc check for replay corruption. Since the crc check is the most time consuming check for parsing (causing microseconds to turn into milliseconds), clients should choose under what circumstances a crc check is performed.

Variants

Always

Always perform the crc check. Useful when the replay has had its contents modified. This will catch a user that increased the number of goals they scored (easy) but only if they didn't update the crc as well (not as easy).

Never

Never perform the crc check. Useful only when it doesn't matter to know if a replay is corrupt or not, you either want the data or the parsing error.

OnError

Only perform the crc check when parsing a section fails. This option gets the best of both worlds. If parsing fails, the crc check will determine if it is a programming error or the replay is corrupt. If parsing succeeds it won't precious time performing the check. This option is the default for parsing.

Trait Implementations

impl Clone for CrcCheck

fn clone(&self) -> CrcCheck

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<CrcCheck> for CrcCheck

fn eq(&self, other: &CrcCheck) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Eq for CrcCheck

impl Copy for CrcCheck

impl Debug for CrcCheck

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

Formats the value using the given formatter.