Struct jack::PortFlags
[−]
pub struct PortFlags { /* fields omitted */ }
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 tojack_port_request_monitor()
makes sense. TODO: implement. Precisely what this means it dependent on the client. A typical result of it being called withtrue
as the second argument is that data that would be available from an output port (withIS_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.
Methods
impl PortFlags
fn empty() -> PortFlags
Returns an empty set of flags.
fn all() -> PortFlags
Returns the set containing all flags.
fn bits(&self) -> u32
Returns the raw value of the flags currently stored.
fn from_bits(bits: u32) -> Option<PortFlags>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
fn from_bits_truncate(bits: u32) -> PortFlags
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: PortFlags) -> bool
Returns true
if there are flags common to both self
and other
.
fn contains(&self, other: PortFlags) -> bool
Returns true
all of the flags in other
are contained within self
.
fn insert(&mut self, other: PortFlags)
Inserts the specified flags in-place.
fn remove(&mut self, other: PortFlags)
Removes the specified flags in-place.
fn toggle(&mut self, other: PortFlags)
Toggles the specified flags in-place.
Trait Implementations
impl Copy for PortFlags
impl PartialEq for PortFlags
fn eq(&self, __arg_0: &PortFlags) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &PortFlags) -> bool
This method tests for !=
.
impl Eq for PortFlags
impl Clone for PortFlags
fn clone(&self) -> PortFlags
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0
Performs copy-assignment from source
. Read more
impl PartialOrd for PortFlags
fn partial_cmp(&self, __arg_0: &PortFlags) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, __arg_0: &PortFlags) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, __arg_0: &PortFlags) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, __arg_0: &PortFlags) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, __arg_0: &PortFlags) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Ord for PortFlags
fn cmp(&self, __arg_0: &PortFlags) -> Ordering
This method returns an Ordering
between self
and other
. Read more
impl Hash for PortFlags
fn hash<__H: Hasher>(&self, __arg_0: &mut __H)
Feeds this value into the state given, updating the hasher as necessary.
fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher
1.3.0
Feeds a slice of this type into the state provided.
impl Debug for PortFlags
impl BitOr 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 BitOrAssign for PortFlags
fn bitor_assign(&mut self, other: PortFlags)
Adds the set of flags.
impl BitXor 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 BitXorAssign for PortFlags
fn bitxor_assign(&mut self, other: PortFlags)
Toggles the set of flags.
impl BitAnd 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 BitAndAssign for PortFlags
fn bitand_assign(&mut self, other: PortFlags)
Disables all flags disabled in the set.
impl Sub 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 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 Extend<PortFlags> for PortFlags
fn extend<T: IntoIterator<Item=PortFlags>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
impl FromIterator<PortFlags> for PortFlags
fn from_iter<T: IntoIterator<Item=PortFlags>>(iterator: T) -> PortFlags
Creates a value from an iterator. Read more