pub struct PortFlags { /* private fields */ }
Expand description
Flags for specifying port options.
Implementations§
source§impl PortFlags
impl PortFlags
sourcepub const IS_PHYSICAL: Self = _
pub const IS_PHYSICAL: Self = _
Port corresponds to some kind of physical I/O connector.
sourcepub const CAN_MONITOR: Self = _
pub const CAN_MONITOR: Self = _
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.
sourcepub const IS_TERMINAL: Self = _
pub const IS_TERMINAL: Self = _
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.
sourcepub const fn bits(&self) -> Enum_JackPortFlags
pub const fn bits(&self) -> Enum_JackPortFlags
Returns the raw value of the flags currently stored.
sourcepub const fn from_bits(bits: Enum_JackPortFlags) -> Option<Self>
pub const fn from_bits(bits: Enum_JackPortFlags) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: Enum_JackPortFlags) -> Self
pub const fn from_bits_truncate(bits: Enum_JackPortFlags) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: Enum_JackPortFlags) -> Self
pub const unsafe fn from_bits_unchecked(bits: Enum_JackPortFlags) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
Trait Implementations§
source§impl BitAndAssign<PortFlags> for PortFlags
impl BitAndAssign<PortFlags> for PortFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOrAssign<PortFlags> for PortFlags
impl BitOrAssign<PortFlags> for PortFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXorAssign<PortFlags> for PortFlags
impl BitXorAssign<PortFlags> for PortFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Extend<PortFlags> for PortFlags
impl Extend<PortFlags> for PortFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl FromIterator<PortFlags> for PortFlags
impl FromIterator<PortFlags> for PortFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Ord for PortFlags
impl Ord for PortFlags
source§impl PartialEq<PortFlags> for PortFlags
impl PartialEq<PortFlags> for PortFlags
source§impl PartialOrd<PortFlags> for PortFlags
impl PartialOrd<PortFlags> for PortFlags
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl SubAssign<PortFlags> for PortFlags
impl SubAssign<PortFlags> for PortFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.