Struct ladspa::ControlHint

pub struct ControlHint { /* fields omitted */ }

Represents the special properties a control port may hold. These are merely hints as to the use of the port and may be completely ignored by the host. For audio ports, use CONTROL_HINT_NONE. To attach multiple properties, bitwise-or them together. See documentation for the constants beginning with HINT_ for the more information.

Methods

impl ControlHint

fn empty() -> ControlHint

Returns an empty set of flags.

fn all() -> ControlHint

Returns the set containing all flags.

fn bits(&self) -> i32

Returns the raw value of the flags currently stored.

fn from_bits(bits: i32) -> Option<ControlHint>

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

fn from_bits_truncate(bits: i32) -> ControlHint

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

fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

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

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

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

fn insert(&mut self, other: ControlHint)

Inserts the specified flags in-place.

fn remove(&mut self, other: ControlHint)

Removes the specified flags in-place.

fn toggle(&mut self, other: ControlHint)

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Copy for ControlHint

impl PartialEq for ControlHint

fn eq(&self, __arg_0: &ControlHint) -> bool

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

fn ne(&self, __arg_0: &ControlHint) -> bool

This method tests for !=.

impl Eq for ControlHint

impl Clone for ControlHint

fn clone(&self) -> ControlHint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd for ControlHint

fn partial_cmp(&self, __arg_0: &ControlHint) -> Option<Ordering>

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

fn lt(&self, __arg_0: &ControlHint) -> bool

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

fn le(&self, __arg_0: &ControlHint) -> bool

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

fn gt(&self, __arg_0: &ControlHint) -> bool

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

fn ge(&self, __arg_0: &ControlHint) -> bool

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

impl Ord for ControlHint

fn cmp(&self, __arg_0: &ControlHint) -> Ordering

This method returns an Ordering between self and other.

impl Hash for ControlHint

fn hash<__H: Hasher>(&self, __arg_0: &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 Debug for ControlHint

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

Formats the value using the given formatter.

impl BitOr for ControlHint

type Output = ControlHint

The resulting type after applying the | operator

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

Returns the union of the two sets of flags.

impl BitOrAssign for ControlHint

fn bitor_assign(&mut self, other: ControlHint)

Adds the set of flags.

impl BitXor for ControlHint

type Output = ControlHint

The resulting type after applying the ^ operator

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

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

impl BitXorAssign for ControlHint

fn bitxor_assign(&mut self, other: ControlHint)

Toggles the set of flags.

impl BitAnd for ControlHint

type Output = ControlHint

The resulting type after applying the & operator

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

Returns the intersection between the two sets of flags.

impl BitAndAssign for ControlHint

fn bitand_assign(&mut self, other: ControlHint)

Disables all flags disabled in the set.

impl Sub for ControlHint

type Output = ControlHint

The resulting type after applying the - operator

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

Returns the set difference of the two sets of flags.

impl SubAssign for ControlHint

fn sub_assign(&mut self, other: ControlHint)

Disables all flags enabled in the set.

impl Not for ControlHint

type Output = ControlHint

The resulting type after applying the ! operator

fn not(self) -> ControlHint

Returns the complement of this set of flags.

impl Extend<ControlHint> for ControlHint

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

Extends a collection with the contents of an iterator.

impl FromIterator<ControlHint> for ControlHint

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

Creates a value from an iterator.