Struct jack::ClientOptions

pub struct ClientOptions { /* fields omitted */ }

Option flags for opening a JACK client.

Implementations

impl ClientOptions

pub const NO_START_SERVER: ClientOptions

Do not automatically start the JACK server when it is not already running. This option is always selected if $JACK_NO_START_SERVER is defined in the calling process environment.

pub const USE_EXACT_NAME: ClientOptions

Use the exact client name requested. Otherwise, JACK automatically generates a unique one if needed.

pub const SERVER_NAME: ClientOptions

Open with optional server_name parameter.

TODO: implement

pub const LOAD_NAME: ClientOptions

Load internal client from optional load_name, otherwise use the client_name.

TODO(wmedrano): Implement load_name functionality

pub const LOAD_INIT: ClientOptions

Pass optional load_init to jack_initialize() entry point of an internal client.

TODO: implement

pub const SESSION_ID: ClientOptions

Pass a SessionID token. This allows the session manager to identify the client again.

pub const fn empty() -> ClientOptions

Returns an empty set of flags

pub const fn all() -> ClientOptions

Returns the set containing all flags.

pub const fn bits(&self) -> Enum_JackOptions

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: Enum_JackOptions) -> Option<ClientOptions>

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_JackOptions) -> ClientOptions

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

pub const unsafe fn from_bits_unchecked(bits: Enum_JackOptions) -> ClientOptions

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for ClientOptions

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

Formats the value using the given formatter.

impl BitAnd<ClientOptions> for ClientOptions

type Output = ClientOptions

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<ClientOptions> for ClientOptions

fn bitand_assign(&mut self, other: ClientOptions)

Disables all flags disabled in the set.

impl BitOr<ClientOptions> for ClientOptions

type Output = ClientOptions

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<ClientOptions> for ClientOptions

fn bitor_assign(&mut self, other: ClientOptions)

Adds the set of flags.

impl BitXor<ClientOptions> for ClientOptions

type Output = ClientOptions

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<ClientOptions> for ClientOptions

fn bitxor_assign(&mut self, other: ClientOptions)

Toggles the set of flags.

impl Clone for ClientOptions

fn clone(&self) -> ClientOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ClientOptions

impl Debug for ClientOptions

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

Formats the value using the given formatter.

impl Eq for ClientOptions

impl Extend<ClientOptions> for ClientOptions

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

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

Creates a value from an iterator.

impl Hash for ClientOptions

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 ClientOptions

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

Formats the value using the given formatter.

impl Not for ClientOptions

type Output = ClientOptions

The resulting type after applying the ! operator.

fn not(self) -> ClientOptions

Returns the complement of this set of flags.

impl Octal for ClientOptions

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

Formats the value using the given formatter.

impl Ord for ClientOptions

fn cmp(&self, other: &ClientOptions) -> 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<ClientOptions> for ClientOptions

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

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

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

This method tests for !=.

impl PartialOrd<ClientOptions> for ClientOptions

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for ClientOptions

impl StructuralPartialEq for ClientOptions

impl Sub<ClientOptions> for ClientOptions

type Output = ClientOptions

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<ClientOptions> for ClientOptions

fn sub_assign(&mut self, other: ClientOptions)

Disables all flags enabled in the set.

impl UpperHex for ClientOptions

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

Formats the value using the given formatter.