Struct fpsdk::SampleLoadFlags

pub struct SampleLoadFlags { /* fields omitted */ }

Sample loading flags.

Implementations

impl SampleLoadFlags

pub const SHOW_DIALOG: SampleLoadFlags

This tells the sample loader to show an open box, for the user to select a sample

pub const FORCE_RELOAD: SampleLoadFlags

Force the sample to be reloaded, even if the filename is the same.

This is handy in case you modified the sample, for example

pub const GET_NAME: SampleLoadFlags

Don't load the sample, instead get its filename & make sure that the format is correct

(useful after host::HostMessage::ChanSampleChanged)

pub const NO_RESAMPLING: SampleLoadFlags

Don't resample to the host sample rate

pub const fn empty() -> SampleLoadFlags

Returns an empty set of flags

pub const fn all() -> SampleLoadFlags

Returns the set containing all flags.

pub const fn bits(&self) -> isize

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: isize) -> Option<SampleLoadFlags>

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

pub const fn from_bits_truncate(bits: isize) -> SampleLoadFlags

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

pub const unsafe fn from_bits_unchecked(bits: isize) -> SampleLoadFlags

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: SampleLoadFlags) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for SampleLoadFlags

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

Formats the value using the given formatter.

impl BitAnd<SampleLoadFlags> for SampleLoadFlags

type Output = SampleLoadFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<SampleLoadFlags> for SampleLoadFlags

fn bitand_assign(&mut self, other: SampleLoadFlags)

Disables all flags disabled in the set.

impl BitOr<SampleLoadFlags> for SampleLoadFlags

type Output = SampleLoadFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<SampleLoadFlags> for SampleLoadFlags

fn bitor_assign(&mut self, other: SampleLoadFlags)

Adds the set of flags.

impl BitXor<SampleLoadFlags> for SampleLoadFlags

type Output = SampleLoadFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<SampleLoadFlags> for SampleLoadFlags

fn bitxor_assign(&mut self, other: SampleLoadFlags)

Toggles the set of flags.

impl Clone for SampleLoadFlags

fn clone(&self) -> SampleLoadFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for SampleLoadFlags

impl Debug for SampleLoadFlags

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

Formats the value using the given formatter.

impl Eq for SampleLoadFlags

impl Extend<SampleLoadFlags> for SampleLoadFlags

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

Extends a collection with the contents of an iterator.

impl FromIterator<SampleLoadFlags> for SampleLoadFlags

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

Creates a value from an iterator.

impl Hash for SampleLoadFlags

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 SampleLoadFlags

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

Formats the value using the given formatter.

impl Not for SampleLoadFlags

type Output = SampleLoadFlags

The resulting type after applying the ! operator.

fn not(self) -> SampleLoadFlags

Returns the complement of this set of flags.

impl Octal for SampleLoadFlags

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

Formats the value using the given formatter.

impl Ord for SampleLoadFlags

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

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

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

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

This method tests for !=.

impl PartialOrd<SampleLoadFlags> for SampleLoadFlags

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for SampleLoadFlags

impl StructuralPartialEq for SampleLoadFlags

impl Sub<SampleLoadFlags> for SampleLoadFlags

type Output = SampleLoadFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<SampleLoadFlags> for SampleLoadFlags

fn sub_assign(&mut self, other: SampleLoadFlags)

Disables all flags enabled in the set.

impl UpperHex for SampleLoadFlags

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

Formats the value using the given formatter.