Struct lofty::GlobalOptions

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

Options that control all interactions with Lofty for the current thread

Examples

use lofty::GlobalOptions;

// I have a custom resolver that I need checked
let global_options = GlobalOptions::new().use_custom_resolvers(true);
lofty::apply_global_options(global_options);

Implementations

impl GlobalOptions

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 GlobalOptions, alias for Default implementation

See also: GlobalOptions::default

Examples

use lofty::GlobalOptions;

let global_options = GlobalOptions::new();

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::GlobalOptions;

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

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.

Examples

use lofty::GlobalOptions;

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

Trait Implementations

impl Clone for GlobalOptions

fn clone(&self) -> GlobalOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GlobalOptions

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

Formats the value using the given formatter.

impl Default for GlobalOptions

fn default() -> Self

The default implementation for GlobalOptions

The defaults are as follows:

GlobalOptions {
	use_custom_resolvers: true,
	allocation_limit: Self::DEFAULT_ALLOCATION_LIMIT,
}

impl Ord for GlobalOptions

fn cmp(&self, other: &GlobalOptions) -> 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 GlobalOptions

fn eq(&self, other: &GlobalOptions) -> 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 GlobalOptions

fn partial_cmp(&self, other: &GlobalOptions) -> 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 GlobalOptions

impl Eq for GlobalOptions

impl StructuralEq for GlobalOptions

impl StructuralPartialEq for GlobalOptions