Struct jack::ClientStatus
source · [−]pub struct ClientStatus { /* private fields */ }
Expand description
Status flags for JACK clients.
Implementations
sourceimpl ClientStatus
impl ClientStatus
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
sourceimpl Binary for ClientStatus
impl Binary for ClientStatus
sourceimpl BitAnd<ClientStatus> for ClientStatus
impl BitAnd<ClientStatus> for ClientStatus
sourceimpl BitAndAssign<ClientStatus> for ClientStatus
impl BitAndAssign<ClientStatus> for ClientStatus
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<ClientStatus> for ClientStatus
impl BitOr<ClientStatus> for ClientStatus
sourcefn bitor(self, other: ClientStatus) -> Self
fn bitor(self, other: ClientStatus) -> Self
Returns the union of the two sets of flags.
type Output = Self
type Output = Self
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<ClientStatus> for ClientStatus
impl BitOrAssign<ClientStatus> for ClientStatus
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<ClientStatus> for ClientStatus
impl BitXor<ClientStatus> for ClientStatus
sourceimpl BitXorAssign<ClientStatus> for ClientStatus
impl BitXorAssign<ClientStatus> for ClientStatus
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for ClientStatus
impl Clone for ClientStatus
sourcefn clone(&self) -> ClientStatus
fn clone(&self) -> ClientStatus
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ClientStatus
impl Debug for ClientStatus
sourceimpl Extend<ClientStatus> for ClientStatus
impl Extend<ClientStatus> for ClientStatus
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<ClientStatus> for ClientStatus
impl FromIterator<ClientStatus> for ClientStatus
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl Hash for ClientStatus
impl Hash for ClientStatus
sourceimpl LowerHex for ClientStatus
impl LowerHex for ClientStatus
sourceimpl Not for ClientStatus
impl Not for ClientStatus
sourceimpl Octal for ClientStatus
impl Octal for ClientStatus
sourceimpl Ord for ClientStatus
impl Ord for ClientStatus
sourceimpl PartialEq<ClientStatus> for ClientStatus
impl PartialEq<ClientStatus> for ClientStatus
sourcefn eq(&self, other: &ClientStatus) -> bool
fn eq(&self, other: &ClientStatus) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ClientStatus) -> bool
fn ne(&self, other: &ClientStatus) -> bool
This method tests for !=
.
sourceimpl PartialOrd<ClientStatus> for ClientStatus
impl PartialOrd<ClientStatus> for ClientStatus
sourcefn partial_cmp(&self, other: &ClientStatus) -> Option<Ordering>
fn partial_cmp(&self, other: &ClientStatus) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl Sub<ClientStatus> for ClientStatus
impl Sub<ClientStatus> for ClientStatus
sourceimpl SubAssign<ClientStatus> for ClientStatus
impl SubAssign<ClientStatus> for ClientStatus
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for ClientStatus
impl UpperHex for ClientStatus
impl Copy for ClientStatus
impl Eq for ClientStatus
impl StructuralEq for ClientStatus
impl StructuralPartialEq for ClientStatus
Auto Trait Implementations
impl RefUnwindSafe for ClientStatus
impl Send for ClientStatus
impl Sync for ClientStatus
impl Unpin for ClientStatus
impl UnwindSafe for ClientStatus
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more