Struct jack::ClientStatus

pub struct ClientStatus { /* private fields */ }

Status flags for JACK clients.

Implementations

impl ClientStatus

pub const FAILURE: Self = _

Overall operation failed. File an issue if you can get it to appear.

pub const INVALID_OPTION: Self = _

The operation contained an invalid or unsupported option.

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.

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.

pub const SERVER_FAILED: Self = _

Unable to connect to the JACK server.

pub const SERVER_ERROR: Self = _

Communication error with the JACK server.

pub const NO_SUCH_CLIENT: Self = _

Requested client does not exist.

pub const LOAD_FAILURE: Self = _

Unable to load internal client

pub const INIT_FAILURE: Self = _

Unable to initialize client

pub const SHM_FAILURE: Self = _

Unable to access shared memory

pub const VERSION_ERROR: Self = _

Client’s protocol version does not match

pub const BACKEND_ERROR: Self = _

No documentation found. TODO: dig deeper

pub const CLIENT_ZOMBIE: Self = _

No documentation found. TODO: dig deeper

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> Enum_JackStatus

Returns the raw value of the flags currently stored.

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.

pub const fn from_bits_truncate(bits: Enum_JackStatus) -> Self

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

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.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

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

pub const fn contains(&self, other: Self) -> bool

Returns true if all of the flags in other are contained within self.

pub fn insert(&mut self, other: Self)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Self)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Self)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Self, value: bool)

Inserts or removes the specified flags depending on the passed value.

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.

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.

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.

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.

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

impl Binary for ClientStatus

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

Formats the value using the given formatter.

impl BitAnd<ClientStatus> for ClientStatus

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

Returns the intersection between the two sets of flags.

type Output = ClientStatus

The resulting type after applying the & operator.

impl BitAndAssign<ClientStatus> for ClientStatus

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<ClientStatus> for ClientStatus

fn bitor(self, other: ClientStatus) -> Self

Returns the union of the two sets of flags.

type Output = ClientStatus

The resulting type after applying the | operator.

impl BitOrAssign<ClientStatus> for ClientStatus

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<ClientStatus> for ClientStatus

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

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

type Output = ClientStatus

The resulting type after applying the ^ operator.

impl BitXorAssign<ClientStatus> for ClientStatus

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for ClientStatus

fn clone(&self) -> ClientStatus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientStatus

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

Formats the value using the given formatter.

impl Extend<ClientStatus> for ClientStatus

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

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

Creates a value from an iterator.

impl Hash for ClientStatus

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 LowerHex for ClientStatus

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

Formats the value using the given formatter.

impl Not for ClientStatus

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = ClientStatus

The resulting type after applying the ! operator.

impl Octal for ClientStatus

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

Formats the value using the given formatter.

impl Ord for ClientStatus

fn cmp(&self, other: &ClientStatus) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<ClientStatus> for ClientStatus

fn eq(&self, other: &ClientStatus) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<ClientStatus> for ClientStatus

fn partial_cmp(&self, other: &ClientStatus) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub<ClientStatus> for ClientStatus

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

Returns the set difference of the two sets of flags.

type Output = ClientStatus

The resulting type after applying the - operator.

impl SubAssign<ClientStatus> for ClientStatus

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for ClientStatus

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

Formats the value using the given formatter.

impl Copy for ClientStatus

impl Eq for ClientStatus

impl StructuralEq for ClientStatus

impl StructuralPartialEq for ClientStatus