Struct discid::Features

pub struct Features { /* fields omitted */ }

Constants representing the features supported by libdiscid.

See DiscId::read_features for details.

Implementations

impl Features

pub const READ: Features

Read the CD TOC.

This is supported on all platforms and indicates that only the table of contents (TOC), from which the disc ID gets calculated, will be read.

pub const MCN: Features

Read the MCN (aka barcode) information.

Read the MCN field from the CD. Not all CDs provide this information. Without this feature DiscId::mcn will always return an empty string.

pub const ISRC: Features

Supports reading the ISRCs per track.

For each track read the ISRC encoded in the subchannel data. Not all CDs provide this information. Without this feature Track::isrc will always be an empty string.

pub const fn empty() -> Features

Returns an empty set of flags

pub const fn all() -> Features

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<Features>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> Features

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> Features

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: Features) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: Features) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: Features)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Features)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Features)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Features, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for Features

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

Formats the value using the given formatter.

impl BitAnd<Features> for Features

type Output = Features

The resulting type after applying the & operator.

fn bitand(self, other: Features) -> Features

Returns the intersection between the two sets of flags.

impl BitAndAssign<Features> for Features

fn bitand_assign(&mut self, other: Features)

Disables all flags disabled in the set.

impl BitOr<Features> for Features

type Output = Features

The resulting type after applying the | operator.

fn bitor(self, other: Features) -> Features

Returns the union of the two sets of flags.

impl BitOrAssign<Features> for Features

fn bitor_assign(&mut self, other: Features)

Adds the set of flags.

impl BitXor<Features> for Features

type Output = Features

The resulting type after applying the ^ operator.

fn bitxor(self, other: Features) -> Features

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<Features> for Features

fn bitxor_assign(&mut self, other: Features)

Toggles the set of flags.

impl Clone for Features

fn clone(&self) -> Features

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Features

impl Debug for Features

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

Formats the value using the given formatter.

impl Eq for Features

impl Extend<Features> for Features

fn extend<T: IntoIterator<Item = Features>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<Features> for Features

fn from_iter<T: IntoIterator<Item = Features>>(iterator: T) -> Features

Creates a value from an iterator.

impl Hash for Features

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl LowerHex for Features

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

Formats the value using the given formatter.

impl Not for Features

type Output = Features

The resulting type after applying the ! operator.

fn not(self) -> Features

Returns the complement of this set of flags.

impl Octal for Features

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

Formats the value using the given formatter.

impl Ord for Features

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Features> for Features

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

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

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

This method tests for !=.

impl PartialOrd<Features> for Features

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

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

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

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

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

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

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

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

fn ge(&self, other: &Features) -> bool

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

impl StructuralEq for Features

impl StructuralPartialEq for Features

impl Sub<Features> for Features

type Output = Features

The resulting type after applying the - operator.

fn sub(self, other: Features) -> Features

Returns the set difference of the two sets of flags.

impl SubAssign<Features> for Features

fn sub_assign(&mut self, other: Features)

Disables all flags enabled in the set.

impl UpperHex for Features

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

Formats the value using the given formatter.