Struct jack::ClientStatus

pub struct ClientStatus { /* fields omitted */ }

Status flags for JACK clients.

Implementations

impl ClientStatus

pub const FAILURE: ClientStatus

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

pub const INVALID_OPTION: ClientStatus

The operation contained an invalid or unsupported option.

pub const NAME_NOT_UNIQUE: ClientStatus

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: ClientStatus

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: ClientStatus

Unable to connect to the JACK server.

pub const SERVER_ERROR: ClientStatus

Communication error with the JACK server.

pub const NO_SUCH_CLIENT: ClientStatus

Requested client does not exist.

pub const LOAD_FAILURE: ClientStatus

Unable to load internal client

pub const INIT_FAILURE: ClientStatus

Unable to initialize client

pub const SHM_FAILURE: ClientStatus

Unable to access shared memory

pub const VERSION_ERROR: ClientStatus

Client's protocol version does not match

pub const BACKEND_ERROR: ClientStatus

No documentation found. TODO: dig deeper

pub const CLIENT_ZOMBIE: ClientStatus

No documentation found. TODO: dig deeper

pub const fn empty() -> ClientStatus

Returns an empty set of flags

pub const fn all() -> ClientStatus

Returns the set containing all flags.

pub const fn bits(&self) -> Enum_JackStatus

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: Enum_JackStatus) -> Option<ClientStatus>

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) -> ClientStatus

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

pub const unsafe fn from_bits_unchecked(bits: Enum_JackStatus) -> ClientStatus

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

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: ClientStatus) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

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

type Output = ClientStatus

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<ClientStatus> for ClientStatus

fn bitand_assign(&mut self, other: ClientStatus)

Disables all flags disabled in the set.

impl BitOr<ClientStatus> for ClientStatus

type Output = ClientStatus

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<ClientStatus> for ClientStatus

fn bitor_assign(&mut self, other: ClientStatus)

Adds the set of flags.

impl BitXor<ClientStatus> for ClientStatus

type Output = ClientStatus

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<ClientStatus> for ClientStatus

fn bitxor_assign(&mut self, other: ClientStatus)

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

impl Debug for ClientStatus

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

Formats the value using the given formatter.

impl Eq for ClientStatus

impl Extend<ClientStatus> for ClientStatus

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

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, 

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

type Output = ClientStatus

The resulting type after applying the ! operator.

fn not(self) -> ClientStatus

Returns the complement of this set of flags.

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.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

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: &ClientStatus) -> bool

This method tests for !=.

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: &ClientStatus) -> bool

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

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

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

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

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

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

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

impl StructuralEq for ClientStatus

impl StructuralPartialEq for ClientStatus

impl Sub<ClientStatus> for ClientStatus

type Output = ClientStatus

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<ClientStatus> for ClientStatus

fn sub_assign(&mut self, other: ClientStatus)

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.