Struct jack::PortFlags

pub struct PortFlags { /* fields omitted */ }

Flags for specifying port options.

Methods

impl PortFlags

pub const IS_INPUT: PortFlags

The port can receive data.

pub const IS_OUTPUT: PortFlags

Data can be read from the port.

pub const IS_PHYSICAL: PortFlags

Port corresponds to some kind of physical I/O connector.

pub const CAN_MONITOR: PortFlags

A call to jack_port_request_monitor() makes sense.

TODO implement

Precisely what this means it dependent on the client. A typical result of it being called with true as the second argument is that data that would be available from an output port (with IS_PHYSICAL set) is sent to a physical output connector as well, so that it can be heard/seen/whatever.

pub const IS_TERMINAL: PortFlags

For an input port, the data received by the port will not be passed on or made available at any other port. For output, the data available at the port does not originate from any other port. Audio synthesizers, I/O hardware interface clients, HDR systems are examples of clients that would set this flag for their ports.

pub const fn empty() -> PortFlags

Returns an empty set of flags

pub const fn all() -> PortFlags

Returns the set containing all flags.

pub const fn bits(&self) -> Enum_JackPortFlags

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: Enum_JackPortFlags) -> Option<PortFlags>

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

pub const fn from_bits_truncate(bits: Enum_JackPortFlags) -> PortFlags

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Ord for PortFlags

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialOrd<PortFlags> for PortFlags

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

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

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

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

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

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

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

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

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

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

impl PartialEq<PortFlags> for PortFlags

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

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

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

This method tests for !=.

impl Extend<PortFlags> for PortFlags

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

Extends a collection with the contents of an iterator.

impl Clone for PortFlags

fn clone(&self) -> PortFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for PortFlags

impl Copy for PortFlags

impl Debug for PortFlags

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

Formats the value using the given formatter.

impl Sub<PortFlags> for PortFlags

type Output = PortFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<PortFlags> for PortFlags

fn sub_assign(&mut self, other: PortFlags)

Disables all flags enabled in the set.

impl Not for PortFlags

type Output = PortFlags

The resulting type after applying the ! operator.

fn not(self) -> PortFlags

Returns the complement of this set of flags.

impl BitAnd<PortFlags> for PortFlags

type Output = PortFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitOr<PortFlags> for PortFlags

type Output = PortFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitXor<PortFlags> for PortFlags

type Output = PortFlags

The resulting type after applying the ^ operator.

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

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

impl BitAndAssign<PortFlags> for PortFlags

fn bitand_assign(&mut self, other: PortFlags)

Disables all flags disabled in the set.

impl BitOrAssign<PortFlags> for PortFlags

fn bitor_assign(&mut self, other: PortFlags)

Adds the set of flags.

impl BitXorAssign<PortFlags> for PortFlags

fn bitxor_assign(&mut self, other: PortFlags)

Toggles the set of flags.

impl Hash for PortFlags

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 FromIterator<PortFlags> for PortFlags

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

Creates a value from an iterator.

impl Octal for PortFlags

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

Formats the value using the given formatter.

impl Binary for PortFlags

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

Formats the value using the given formatter.

impl LowerHex for PortFlags

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

Formats the value using the given formatter.

impl UpperHex for PortFlags

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

Formats the value using the given formatter.