Struct PortFlags 

pub struct PortFlags { /* private fields */ }

Flags for specifying port options.

• IS_INPUT - The port can receive data.

• IS_OUTPUT - Data can be read from the port.

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

• CAN_MONITOR - 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.

• IS_TERMINAL - 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.

Implementations

impl PortFlags

pub fn empty() -> PortFlags

Returns an empty set of flags.

pub fn all() -> PortFlags

Returns the set containing all flags.

pub fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

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

pub fn from_bits_truncate(bits: u32) -> PortFlags

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

pub fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

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

pub 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.

Trait Implementations

impl BitAnd for PortFlags

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

Returns the intersection between the two sets of flags.

type Output = PortFlags

The resulting type after applying the & operator.

impl BitAndAssign for PortFlags

fn bitand_assign(&mut self, other: PortFlags)

Disables all flags disabled in the set.

impl BitOr for PortFlags

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

Returns the union of the two sets of flags.

type Output = PortFlags

The resulting type after applying the | operator.

impl BitOrAssign for PortFlags

fn bitor_assign(&mut self, other: PortFlags)

Adds the set of flags.

impl BitXor for PortFlags

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

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

type Output = PortFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for PortFlags

fn bitxor_assign(&mut self, other: PortFlags)

Toggles the set of flags.

impl Clone for PortFlags

fn clone(&self) -> PortFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PortFlags

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

Formats the value using the given formatter.

impl Extend<PortFlags> for PortFlags

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

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

Creates a value from an iterator.

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

Feeds a slice of this type into the given Hasher.

impl Not for PortFlags

fn not(self) -> PortFlags

Returns the complement of this set of flags.

type Output = PortFlags

The resulting type after applying the ! operator.

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

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 PortFlags

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

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

Returns the set difference of the two sets of flags.

type Output = PortFlags

The resulting type after applying the - operator.

impl SubAssign for PortFlags

fn sub_assign(&mut self, other: PortFlags)

Disables all flags enabled in the set.

impl Copy for PortFlags

impl Eq for PortFlags

impl StructuralPartialEq for PortFlags