ClientStatus

Struct ClientStatus 

Source
pub struct ClientStatus { /* private fields */ }
Expand description

Status flags for Jack clients.

  • FAILURE - Overall operation failed.

  • INVALID_OPTION - The operation contained an invalid or unsupported option.

  • NAME_NOT_UNIQUE - 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.

  • SERVER_STARTED - 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.

  • SERVER_FAILED - Unable to connect to the JACK server.

  • SERVER_ERROR - Communication error with the JACK server.

  • NO_SUCH_CLIENT - Requested client does not exist.

  • LOAD_FAILURE - Unable to load internal client

  • INIT_FAILURE - Unable to initialize client

  • SHM_FAILURE - Unable to access shared memory

  • VERSION_ERROR - Client’s protocol version does not match

  • BACKEND_ERROR - No documentation found. TODO: dig deeper

  • CLIENT_ZOZMBIE - No documentation found. TODO: dig deeper

  • UNKNOWN_ERROR - Not part of jack and shouldn’t occur ever. File an issue if you can get it to appear.

Implementations§

Source§

impl ClientStatus

Source

pub fn empty() -> ClientStatus

Returns an empty set of flags.

Source

pub fn all() -> ClientStatus

Returns the set containing all flags.

Source

pub fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

Source

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

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

Source

pub fn from_bits_truncate(bits: u32) -> ClientStatus

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

Source

pub fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

Source

pub fn is_all(&self) -> bool

Returns true if all flags are currently set.

Source

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

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

Source

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

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

Source

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

Inserts the specified flags in-place.

Source

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

Removes the specified flags in-place.

Source

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

Toggles the specified flags in-place.

Trait Implementations§

Source§

impl BitAnd for ClientStatus

Source§

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

Returns the intersection between the two sets of flags.

Source§

type Output = ClientStatus

The resulting type after applying the & operator.
Source§

impl BitAndAssign for ClientStatus

Source§

fn bitand_assign(&mut self, other: ClientStatus)

Disables all flags disabled in the set.

Source§

impl BitOr for ClientStatus

Source§

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

Returns the union of the two sets of flags.

Source§

type Output = ClientStatus

The resulting type after applying the | operator.
Source§

impl BitOrAssign for ClientStatus

Source§

fn bitor_assign(&mut self, other: ClientStatus)

Adds the set of flags.

Source§

impl BitXor for ClientStatus

Source§

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

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

Source§

type Output = ClientStatus

The resulting type after applying the ^ operator.
Source§

impl BitXorAssign for ClientStatus

Source§

fn bitxor_assign(&mut self, other: ClientStatus)

Toggles the set of flags.

Source§

impl Clone for ClientStatus

Source§

fn clone(&self) -> ClientStatus

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ClientStatus

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Extend<ClientStatus> for ClientStatus

Source§

fn extend<T: IntoIterator<Item = ClientStatus>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator. Read more
Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

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. Read more
Source§

impl FromIterator<ClientStatus> for ClientStatus

Source§

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

Creates a value from an iterator. Read more
Source§

impl Hash for ClientStatus

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Not for ClientStatus

Source§

fn not(self) -> ClientStatus

Returns the complement of this set of flags.

Source§

type Output = ClientStatus

The resulting type after applying the ! operator.
Source§

impl Ord for ClientStatus

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for ClientStatus

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for ClientStatus

Source§

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 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Sub for ClientStatus

Source§

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

Returns the set difference of the two sets of flags.

Source§

type Output = ClientStatus

The resulting type after applying the - operator.
Source§

impl SubAssign for ClientStatus

Source§

fn sub_assign(&mut self, other: ClientStatus)

Disables all flags enabled in the set.

Source§

impl Copy for ClientStatus

Source§

impl Eq for ClientStatus

Source§

impl StructuralPartialEq for ClientStatus

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.