Struct NotesFlags

pub struct NotesFlags { /* private fields */ }

Notes parameters flags.

Implementations

impl NotesFlags

pub const EMPTY_FIRST: NotesFlags

Delete everything currently on the piano roll before adding the notes.

pub const USE_SELECTION: NotesFlags

Put the new notes in the piano roll selection, if there is one.

pub const fn empty() -> NotesFlags

Returns an empty set of flags

pub const fn all() -> NotesFlags

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<NotesFlags>

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) -> NotesFlags

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for NotesFlags

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

Formats the value using the given formatter.

impl BitAnd for NotesFlags

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

Returns the intersection between the two sets of flags.

type Output = NotesFlags

The resulting type after applying the & operator.

impl BitAndAssign for NotesFlags

fn bitand_assign(&mut self, other: NotesFlags)

Disables all flags disabled in the set.

impl BitOr for NotesFlags

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

Returns the union of the two sets of flags.

type Output = NotesFlags

The resulting type after applying the | operator.

impl BitOrAssign for NotesFlags

fn bitor_assign(&mut self, other: NotesFlags)

Adds the set of flags.

impl BitXor for NotesFlags

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

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

type Output = NotesFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for NotesFlags

fn bitxor_assign(&mut self, other: NotesFlags)

Toggles the set of flags.

impl Clone for NotesFlags

fn clone(&self) -> NotesFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NotesFlags

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

Formats the value using the given formatter.

impl Extend<NotesFlags> for NotesFlags

fn extend<T: IntoIterator<Item = NotesFlags>>(&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<NotesFlags> for NotesFlags

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

Creates a value from an iterator.

impl Hash for NotesFlags

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for NotesFlags

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

Formats the value using the given formatter.

impl Not for NotesFlags

fn not(self) -> NotesFlags

Returns the complement of this set of flags.

type Output = NotesFlags

The resulting type after applying the ! operator.

impl Octal for NotesFlags

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

Formats the value using the given formatter.

impl Ord for NotesFlags

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

Restrict a value to a certain interval.

impl PartialEq for NotesFlags

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for NotesFlags

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Sub for NotesFlags

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

Returns the set difference of the two sets of flags.

type Output = NotesFlags

The resulting type after applying the - operator.

impl SubAssign for NotesFlags

fn sub_assign(&mut self, other: NotesFlags)

Disables all flags enabled in the set.

impl UpperHex for NotesFlags

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

Formats the value using the given formatter.

impl Copy for NotesFlags

impl Eq for NotesFlags

impl StructuralPartialEq for NotesFlags