Enum shiratsu_naming::naming::tosec::TOSECToken

pub enum TOSECToken<'a> {
    Title(&'a str),
    Version(&'a str, &'a str, Option<&'a str>),
    Demo(Option<&'a str>),
    Date(&'a str, Option<&'a str>, Option<&'a str>),
    Publisher(Option<Vec<&'a str>>),
    System(&'a str),
    Video(&'a str),
    Region(Vec<&'a str>, Vec<Region>),
    Languages(TOSECLanguage<'a>),
    Copyright(&'a str),
    Development(&'a str),
    DumpInfo(&'a str, Option<&'a str>, Option<&'a str>),
    Media(Vec<(&'a str, &'a str, Option<&'a str>)>),
    Flag(FlagType, &'a str),
    Warning(TOSECWarn<'a>),
}

A token constituent within a TOSECToken.

Tokens are not guaranteed to have consistent semantics outside of a NoIntroName. The order of tokens in a TOSECName is significant in order of appearance in the input file name.

TOSECToken has a custom implementation of PartialOrd following the TOSEC Naming Convention.

Variants

Title(&'a str)

The title of the ROM.

Version(&'a str, &'a str, Option<&'a str>)

A version flag.

Tuple elements

0. The version type.
   • If this is Rev, a space occurs between the version type and the major version.
1. The major version.
2. The minor version, if any.

Demo(Option<&'a str>)

A demo flag, preceding the demo- string.

Examples

• (demo) parses as Demo(None).
• (demo-kiosk) parses as Demo(Some("kiosk"))

Date(&'a str, Option<&'a str>, Option<&'a str>)

A date flag

Tuple elements

0. The year.
1. The month, if any.
2. The day, if any.

Publisher(Option<Vec<&'a str>>)

A publisher flag, with publishers separated by - if more than one.

Examples

• (-) parses as Publisher(None)
• (Publisher A - Doe, John) parses as Publisher(Some(vec!["Publisher A", "Doe, John"]))

System(&'a str)

A system flag.

See the TOSEC Naming Convention for a list of valid system flags.

Video(&'a str)

A video flag.

See the TOSEC Naming Convention for a list of valid video flags.

Region(Vec<&'a str>, Vec<Region>)

The region of the ROM.

Because of the existence of GoodTools region codes in ZZZ-UNK- ROMs, you may not assume a one-to-one correspondence between the strings in the region flag, and the list of parsed regions, since GoodTools regions may go through expansion.

Tuple elements

0. The region strings that correspond to the parsed regions.
1. The parsed regions.

Languages(TOSECLanguage<'a>)

A language flag.

See the TOSECLanguage documentation for more details.

Copyright(&'a str)

A copyright status flag.

See the TOSEC Naming Convention for a list of valid copyright status flags.

Development(&'a str)

A development status flag.

See the TOSEC Naming Convention for a list of valid development status flags.

DumpInfo(&'a str, Option<&'a str>, Option<&'a str>)

A dump info flag.

‘[more info]’ flags are parsed as Flag(FlagType::Bracketed, &'a str), and not DumpInfo.

See the TOSEC Naming Convention for a list of valid dump info flags.

Tuple elements

0. The letter or name of the dump flag.
1. The number of the dump flag, if any.
2. The arguments or additional information of the dump flag, if any. This is an opaque string, and is not specialized with the type of the dump flag.

Example

• [!] parses as DumpInfo("!", None, None)
• [f1 Fix Fixer] parses as DumpInfo("f", Some("1"), Some("Fix Fixer")

Media(Vec<(&'a str, &'a str, Option<&'a str>)>)

A media part number flag.

There may be multiple media parts in a flag, separated by a space.

Media type flags are parsed as Flag(FlagType::Parenthesized, &'a str), and not Media.

Tuple elements

0. The media part name
1. The number of the media part.
2. The total parts of the media, if any.

Examples

• (Side A) parses to Media(vec![("Side", "A", None)]).
• (Disc 1 of 2 Side B) parses to Media(vec[("Disc", "1", Some("2")), ("Side", "B", None)]).

Flag(FlagType, &'a str)

A generic, non-defined, or unknown flag.

Warning(TOSECWarn<'a>)

Indicates an unexpected deviations from the TOSEC Naming convention.

Warnings may be lexical (appearing in the input string) or non-lexical, depending on the warning.

Warnings are always associated with the token following the warning in the resulting TOSECName token stream.

This also means that lexical warnings occur in the order of appearance in the input string.

Trait Implementations

impl<'a> Clone for TOSECToken<'a>

fn clone(&self) -> TOSECToken<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for TOSECToken<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for TOSECToken<'a>

impl<'a> Ord for TOSECToken<'a>

fn cmp(&self, other: &TOSECToken<'a>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<TOSECToken<'_>> for TOSECToken<'_>

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<TOSECToken<'_>> for TOSECToken<'_>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> StructuralEq for TOSECToken<'a>

impl<'a> TokenizedName<'a, TOSECToken<'a>> for TOSECName<'a>

fn title(&self) -> Option<&'a str>

Get the title of the tokenized name.

fn iter(&self) -> Iter<'_, TOSECToken<'a>>

Returns an iterator over the tokens of this name.

fn try_parse<S: AsRef<str> + ?Sized>(input: &'a S) -> Result<Self, NameError>

Tries to parse the input string using the naming convention of this tokenized name.

fn naming_convention() -> NamingConvention

The naming convention of this tokenized name.