Struct lofty::ParseOptions

#[non_exhaustive]
pub struct ParseOptions { /* private fields */ }

Options to control how Lofty parses a file

Implementations

impl ParseOptions

pub const DEFAULT_PARSING_MODE: ParsingMode = ParsingMode::BestAttempt

Default parsing mode

pub const DEFAULT_MAX_JUNK_BYTES: usize = 1_024usize

Default number of junk bytes to read

pub const DEFAULT_ALLOCATION_LIMIT: usize = 16_777_216usize

Default allocation limit for any single tag item

pub const fn new() -> Self

Creates a new ParseOptions, alias for Default implementation

See also: ParseOptions::default

Examples

use lofty::ParseOptions;

let parsing_options = ParseOptions::new();

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

Whether or not to read the audio properties

Examples

use lofty::ParseOptions;

// By default, `read_properties` is enabled. Here, we don't want to read them.
let parsing_options = ParseOptions::new().read_properties(false);

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

Whether or not to check registered custom resolvers

See also: crate::resolve

Examples

use lofty::ParseOptions;

// By default, `use_custom_resolvers` is enabled. Here, we don't want to use them.
let parsing_options = ParseOptions::new().use_custom_resolvers(false);

pub fn parsing_mode(&mut self, parsing_mode: ParsingMode) -> Self

The parsing mode to use, see ParsingMode for details

Examples

use lofty::{ParseOptions, ParsingMode};

// By default, `parsing_mode` is ParsingMode::BestAttempt. Here, we need absolute correctness.
let parsing_options = ParseOptions::new().parsing_mode(ParsingMode::Strict);

pub fn max_junk_bytes(&mut self, max_junk_bytes: usize) -> Self

The maximum number of allowed junk bytes to search

Some information may be surrounded by junk bytes, such as tag padding remnants. This sets the maximum number of junk/unrecognized bytes Lofty will search for required information before giving up.

Examples

use lofty::ParseOptions;

// I have files full of junk, I'll double the search window!
let parsing_options = ParseOptions::new().max_junk_bytes(2048);

pub fn allocation_limit(&mut self, allocation_limit: usize) -> Self

The maximum number of bytes to allocate for any single tag item

This is a safety measure to prevent allocating too much memory for a single tag item. If a tag item exceeds this limit, the allocator will return crate::error::ErrorKind::TooMuchData.

NOTE: This only needs to be set once per thread. The limit will be used for all subsequent reads, until a new one is set.

Examples

use lofty::ParseOptions;

// I have files with gigantic images, I'll double the allocation limit!
let parsing_options = ParseOptions::new().allocation_limit(32 * 1024 * 1024);

Trait Implementations

impl Clone for ParseOptions

fn clone(&self) -> ParseOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParseOptions

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

Formats the value using the given formatter.

impl Default for ParseOptions

fn default() -> Self

The default implementation for ParseOptions

The defaults are as follows:

ParseOptions {
	read_properties: true,
	use_custom_resolvers: true,
	parsing_mode: ParsingMode::BestAttempt,
    max_junk_bytes: 1024
}

impl Ord for ParseOptions

fn cmp(&self, other: &ParseOptions) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ParseOptions

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ParseOptions

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

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

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

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

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

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

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

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

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 Copy for ParseOptions

impl Eq for ParseOptions

impl StructuralEq for ParseOptions

impl StructuralPartialEq for ParseOptions