Struct anitomy::Options

source ·

pub struct Options {
    pub allowed_delimiters: Vec<char>,
    pub ignored_strings: Vec<String>,
    pub parse_episode_number: bool,
    pub parse_episode_title: bool,
    pub parse_file_extension: bool,
    pub parse_release_group: bool,
}

Expand description

The options used by Anitomy to determine how to parse a filename.

Fields

allowed_delimiters: Vec<char>ignored_strings: Vec<String>parse_episode_number: boolparse_episode_title: boolparse_file_extension: boolparse_release_group: bool

Implementations

source

impl Options

source

pub fn new<S: AsRef<str>>(
 allowed_delimiters: &[char],
 ignored_strings: &[S],
 parse_episode_number: bool,
 parse_episode_title: bool,
 parse_file_extension: bool,
 parse_release_group: bool
) -> Self

Construct a new instance of Options with the given settings.

source

pub fn allow_delimiter(&mut self, delimiter: char) -> &mut Self

Adds a delimiter char to the list of allowed delimiters.

source

pub fn allow_delimiters(&mut self, delimiters: &[char]) -> &mut Self

Replaces the list of allowed delimiters.

source

pub fn ignore_string<S: AsRef<str>>(&mut self, string: S) -> &mut Self

Adds a string to the list of ignored strings.

source

pub fn ignore_strings<S: AsRef<str>>(&mut self, strings: &[S]) -> &mut Self

Replaces the list of ignored strings.

source

pub fn parse_episode_number(&mut self, parse: bool) -> &mut Self

Sets whether Anitomy should attempt to parse the episode number.

source

pub fn parse_episode_title(&mut self, parse: bool) -> &mut Self

Sets whether Anitomy should attempt to parse the episode title.

source

pub fn parse_file_extension(&mut self, parse: bool) -> &mut Self

Sets whether Anitomy should attempt to parse the file extension.

source

pub fn parse_release_group(&mut self, parse: bool) -> &mut Self

Sets whether Anitomy should attempt to parse the release group.

Trait Implementations

source

impl Clone for Options

source

fn clone(&self) -> Options

Returns a copy 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 Debug for Options

source

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

Formats the value using the given formatter. Read more

source

impl Default for Options

source

fn default() -> Self

Constructs a new instance of Options with the Anitomy defaults.

Equivalent to:

Options {
    allowed_delimiters: vec![' ', '_', '.', '&', '+', ',', '|'],
    ignored_strings: vec![],
    parse_episode_number: true,
    parse_episode_title: true,
    parse_file_extension: true,
    parse_release_group: true,
}