Struct jack::ClientStatus
source · pub struct ClientStatus { /* private fields */ }
Expand description
Status flags for JACK clients.
Implementations§
source§impl ClientStatus
impl ClientStatus
sourcepub const FAILURE: Self = _
pub const FAILURE: Self = _
Overall operation failed. File an issue if you can get it to appear.
sourcepub const INVALID_OPTION: Self = _
pub const INVALID_OPTION: Self = _
The operation contained an invalid or unsupported option.
sourcepub const NAME_NOT_UNIQUE: Self = _
pub const NAME_NOT_UNIQUE: Self = _
The desired client name was not unique. With the USE_EXACT_NAME
option this situation
is fatal. Otherwise, the name was modified by appending a dash and a two-digit number in
the range “-01” to “-99”. Client::name()
will return the exact string that was
used. If the specified client_name plus these extra characters would be too long, the
open fails instead.
sourcepub const SERVER_STARTED: Self = _
pub const SERVER_STARTED: Self = _
The JACK server was started as a result of this operation. Otherwise, it was running already. In either case the caller is now connected to jackd, so there is no race condition. When the server shuts down, the client will find out.
sourcepub const SERVER_FAILED: Self = _
pub const SERVER_FAILED: Self = _
Unable to connect to the JACK server.
sourcepub const SERVER_ERROR: Self = _
pub const SERVER_ERROR: Self = _
Communication error with the JACK server.
sourcepub const NO_SUCH_CLIENT: Self = _
pub const NO_SUCH_CLIENT: Self = _
Requested client does not exist.
sourcepub const LOAD_FAILURE: Self = _
pub const LOAD_FAILURE: Self = _
Unable to load internal client
sourcepub const INIT_FAILURE: Self = _
pub const INIT_FAILURE: Self = _
Unable to initialize client
sourcepub const SHM_FAILURE: Self = _
pub const SHM_FAILURE: Self = _
Unable to access shared memory
sourcepub const VERSION_ERROR: Self = _
pub const VERSION_ERROR: Self = _
Client’s protocol version does not match
sourcepub const BACKEND_ERROR: Self = _
pub const BACKEND_ERROR: Self = _
No documentation found. TODO: dig deeper
sourcepub const CLIENT_ZOMBIE: Self = _
pub const CLIENT_ZOMBIE: Self = _
No documentation found. TODO: dig deeper
sourcepub const fn bits(&self) -> Enum_JackStatus
pub const fn bits(&self) -> Enum_JackStatus
Returns the raw value of the flags currently stored.
sourcepub const fn from_bits(bits: Enum_JackStatus) -> Option<Self>
pub const fn from_bits(bits: Enum_JackStatus) -> 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_JackStatus) -> Self
pub const fn from_bits_truncate(bits: Enum_JackStatus) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: Enum_JackStatus) -> Self
pub const unsafe fn from_bits_unchecked(bits: Enum_JackStatus) -> 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 Binary for ClientStatus
impl Binary for ClientStatus
source§impl BitAnd<ClientStatus> for ClientStatus
impl BitAnd<ClientStatus> for ClientStatus
source§impl BitAndAssign<ClientStatus> for ClientStatus
impl BitAndAssign<ClientStatus> for ClientStatus
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<ClientStatus> for ClientStatus
impl BitOr<ClientStatus> for ClientStatus
source§fn bitor(self, other: ClientStatus) -> Self
fn bitor(self, other: ClientStatus) -> Self
Returns the union of the two sets of flags.
§type Output = ClientStatus
type Output = ClientStatus
|
operator.source§impl BitOrAssign<ClientStatus> for ClientStatus
impl BitOrAssign<ClientStatus> for ClientStatus
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<ClientStatus> for ClientStatus
impl BitXor<ClientStatus> for ClientStatus
source§impl BitXorAssign<ClientStatus> for ClientStatus
impl BitXorAssign<ClientStatus> for ClientStatus
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for ClientStatus
impl Clone for ClientStatus
source§fn clone(&self) -> ClientStatus
fn clone(&self) -> ClientStatus
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ClientStatus
impl Debug for ClientStatus
source§impl Extend<ClientStatus> for ClientStatus
impl Extend<ClientStatus> for ClientStatus
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<ClientStatus> for ClientStatus
impl FromIterator<ClientStatus> for ClientStatus
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for ClientStatus
impl Hash for ClientStatus
source§impl LowerHex for ClientStatus
impl LowerHex for ClientStatus
source§impl Not for ClientStatus
impl Not for ClientStatus
source§impl Octal for ClientStatus
impl Octal for ClientStatus
source§impl Ord for ClientStatus
impl Ord for ClientStatus
source§fn cmp(&self, other: &ClientStatus) -> Ordering
fn cmp(&self, other: &ClientStatus) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq<ClientStatus> for ClientStatus
impl PartialEq<ClientStatus> for ClientStatus
source§fn eq(&self, other: &ClientStatus) -> bool
fn eq(&self, other: &ClientStatus) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<ClientStatus> for ClientStatus
impl PartialOrd<ClientStatus> for ClientStatus
source§fn partial_cmp(&self, other: &ClientStatus) -> Option<Ordering>
fn partial_cmp(&self, other: &ClientStatus) -> Option<Ordering>
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 Sub<ClientStatus> for ClientStatus
impl Sub<ClientStatus> for ClientStatus
source§impl SubAssign<ClientStatus> for ClientStatus
impl SubAssign<ClientStatus> for ClientStatus
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.