Struct ParamFlags 

pub struct ParamFlags(/* private fields */);

Flags for controlling a parameter’s behavior.

Implementations

impl ParamFlags

pub const BYPASS: ParamFlags

When applied to a BoolParam, this will cause the parameter to be linked to the host’s bypass control. Only a single parameter can be marked as a bypass parameter. If you don’t have a bypass parameter, then nice-plug will add one for you. You will need to implement this yourself if your plugin introduces latency.

pub const NON_AUTOMATABLE: ParamFlags

The parameter cannot be changed from an automation lane. The parameter can however still be manually changed by the user from either the plugin’s own GUI or from the host’s generic UI.

pub const HIDDEN: ParamFlags

Hides the parameter in the host’s generic UI for this plugin. This also implies NON_AUTOMATABLE. Setting this does not prevent you from changing the parameter in the plugin’s editor GUI.

pub const HIDE_IN_GENERIC_UI: ParamFlags

Don’t show this parameter when generating a generic UI for the plugin using one of nice-plug’s generic UI widgets.

impl ParamFlags

pub const fn empty() -> ParamFlags

Get a flags value with all bits unset.

pub const fn all() -> ParamFlags

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

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

Convert from a bits value.

This method will return None if any unknown bits are set.

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

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> ParamFlags

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<ParamFlags>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in self are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in other are also set in self.

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

Whether all set bits in other are also set in self.

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

The bitwise or (|) of the bits in self and other.

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

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in self and other.

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

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: ParamFlags) -> ParamFlags

The bitwise and (&) of the bits in self and other.

pub const fn union(self, other: ParamFlags) -> ParamFlags

The bitwise or (|) of the bits in self and other.

pub const fn difference(self, other: ParamFlags) -> ParamFlags

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: ParamFlags) -> ParamFlags

The bitwise exclusive-or (^) of the bits in self and other.

pub const fn complement(self) -> ParamFlags

The bitwise negation (!) of the bits in self, truncating the result.

impl ParamFlags

pub const fn iter(&self) -> Iter<ParamFlags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<ParamFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for ParamFlags

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

Formats the value using the given formatter.

impl BitAnd for ParamFlags

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

The bitwise and (&) of the bits in self and other.

type Output = ParamFlags

The resulting type after applying the & operator.

impl BitAndAssign for ParamFlags

fn bitand_assign(&mut self, other: ParamFlags)

The bitwise and (&) of the bits in self and other.

impl BitOr for ParamFlags

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

The bitwise or (|) of the bits in self and other.

type Output = ParamFlags

The resulting type after applying the | operator.

impl BitOrAssign for ParamFlags

fn bitor_assign(&mut self, other: ParamFlags)

The bitwise or (|) of the bits in self and other.

impl BitXor for ParamFlags

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

The bitwise exclusive-or (^) of the bits in self and other.

type Output = ParamFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for ParamFlags

fn bitxor_assign(&mut self, other: ParamFlags)

The bitwise exclusive-or (^) of the bits in self and other.

impl Clone for ParamFlags

fn clone(&self) -> ParamFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ParamFlags

impl Debug for ParamFlags

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

Formats the value using the given formatter.

impl Default for ParamFlags

fn default() -> ParamFlags

Returns the “default value” for a type.

impl Eq for ParamFlags

impl Extend<ParamFlags> for ParamFlags

fn extend<T>(&mut self, iterator: T)

where T: IntoIterator<Item = ParamFlags>,

The bitwise or (|) of the bits in each flags value.

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 Flags for ParamFlags

const FLAGS: &'static [Flag<ParamFlags>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> ParamFlags

Convert from a bits value exactly.

fn all_named() -> ParamFlags

Get a flags value with all bits from named flags set.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn known_bits(&self) -> Self::Bits

Get the known bits from a flags value.

fn unknown_bits(&self) -> Self::Bits

Get the unknown bits from a flags value.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by Self::FLAGS.

fn iter_equal_names(&self) -> IterEqualNames<Self>

Get an iterator over all defined names for this flags value.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in other are also set in self.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in other are also set in self.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in self and other.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of self with the complement of other (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in self and other.

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

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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

The bitwise and (&) of the bits in self and other.

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

The bitwise or (|) of the bits in self and other.

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

The intersection of self with the complement of other (&!).

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

The bitwise exclusive-or (^) of the bits in self and other.

fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl FromIterator<ParamFlags> for ParamFlags

fn from_iter<T>(iterator: T) -> ParamFlags

where T: IntoIterator<Item = ParamFlags>,

The bitwise or (|) of the bits in each flags value.

impl IntoIterator for ParamFlags

type Item = ParamFlags

The type of the elements being iterated over.

type IntoIter = Iter<ParamFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <ParamFlags as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for ParamFlags

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

Formats the value using the given formatter.

impl Not for ParamFlags

fn not(self) -> ParamFlags

The bitwise negation (!) of the bits in self, truncating the result.

type Output = ParamFlags

The resulting type after applying the ! operator.

impl Octal for ParamFlags

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

Formats the value using the given formatter.

impl PartialEq for ParamFlags

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

impl Sub for ParamFlags

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

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = ParamFlags

The resulting type after applying the - operator.

impl SubAssign for ParamFlags

fn sub_assign(&mut self, other: ParamFlags)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for ParamFlags

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

Formats the value using the given formatter.