Struct shiratsu_naming::naming::tosec::TOSECName

#[repr(transparent)]
pub struct TOSECName<'a>(_);

A TOSEC format file name.

The order of tokens in a TOSECName is significant in order of appearance in the input file name.

They are also not guaranteed to be strictly conforming to the TOSEC naming convention, but can be made so using TOSECName::into_strict().

Implementations

impl TOSECName<'_>

pub fn without_trailing(self) -> Self

Removes any trailing unparsed string segments from the name.

pub fn into_strict(self) -> Self

Makes the name conform strictly to the TOSEC naming conventions.

This removes any warning tokens and ensures the order of flags is proper.

Fixes

• If there is no date, 19xx is added as the date.
• If there is no publisher, the unknown publisher (-) is added.
• GoodTools region codes are converted into the ISO equivalent.
• Publishers are sorted lexicographically.
• Tags are put in the order

  Title version (demo) (date)(publisher)(system)(video)(country)(language)
  (copyright status)(development status)(media type)(media label)
  [cr][f][h][m][p][t][tr][o][u][v][b][a][!][more info]

• The date ‘19XX’ is changed into ‘19xx’.
• Uppercased development tags are lowercased.

Zero-copy guarantee

This method consumes the tokenized name and remains zero-copy. The zero-copy nature of the parsed tokens mean that some fixes can not be done, such as reorganizing individual publisher names into Surname, Given Name format.

As a result, the strict name may not always conform to the strictest reading of the TOSEC naming convention, especially with regards to alphabetization or malformed flags that were not explicitly specified in listed fixes.

The fixes that are done are only possible by converting the tokenized &'a str into a known &'static str.

Trait Implementations

impl<'a> Clone for TOSECName<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for TOSECName<'a>

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

Formats the value using the given formatter.

impl Display for TOSECName<'_>

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

Formats the value using the given formatter.

impl<'a> From<Vec<TOSECToken<'a>, Global>> for TOSECName<'a>

fn from(vec: Vec<TOSECToken<'a>>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq<TOSECName<'a>> for TOSECName<'a>

fn eq(&self, other: &TOSECName<'a>) -> bool

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

fn ne(&self, other: &TOSECName<'a>) -> bool

This method tests for !=.

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.

impl<'a> Eq for TOSECName<'a>

impl<'a> StructuralEq for TOSECName<'a>

impl<'a> StructuralPartialEq for TOSECName<'a>