Struct jack::ClientOptions
source · [−]pub struct ClientOptions { /* private fields */ }
Expand description
Option flags for opening a JACK client.
Implementations
sourceimpl ClientOptions
impl ClientOptions
sourcepub const NO_START_SERVER: Self
pub const NO_START_SERVER: Self
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.
sourcepub const USE_EXACT_NAME: Self
pub const USE_EXACT_NAME: Self
Use the exact client name requested. Otherwise, JACK automatically generates a unique one if needed.
sourcepub const SERVER_NAME: Self
pub const SERVER_NAME: Self
Open with optional server_name
parameter.
TODO: implement
sourcepub const LOAD_NAME: Self
pub const LOAD_NAME: Self
Load internal client from optional load_name
, otherwise use the client_name
.
TODO(wmedrano): Implement load_name
functionality
sourcepub const LOAD_INIT: Self
pub const LOAD_INIT: Self
Pass optional load_init
to jack_initialize()
entry point of an internal client.
TODO: implement
sourcepub const SESSION_ID: Self
pub const SESSION_ID: Self
Pass a SessionID token. This allows the session manager to identify the client again.
sourcepub const fn bits(&self) -> Enum_JackOptions
pub const fn bits(&self) -> Enum_JackOptions
Returns the raw value of the flags currently stored.
sourcepub const fn from_bits(bits: Enum_JackOptions) -> Option<Self>
pub const fn from_bits(bits: Enum_JackOptions) -> 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_JackOptions) -> Self
pub const fn from_bits_truncate(bits: Enum_JackOptions) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: Enum_JackOptions) -> Self
pub const unsafe fn from_bits_unchecked(bits: Enum_JackOptions) -> 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 ClientOptions
impl Binary for ClientOptions
sourceimpl BitAnd<ClientOptions> for ClientOptions
impl BitAnd<ClientOptions> for ClientOptions
sourceimpl BitAndAssign<ClientOptions> for ClientOptions
impl BitAndAssign<ClientOptions> for ClientOptions
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<ClientOptions> for ClientOptions
impl BitOr<ClientOptions> for ClientOptions
sourcefn bitor(self, other: ClientOptions) -> Self
fn bitor(self, other: ClientOptions) -> 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<ClientOptions> for ClientOptions
impl BitOrAssign<ClientOptions> for ClientOptions
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<ClientOptions> for ClientOptions
impl BitXor<ClientOptions> for ClientOptions
sourceimpl BitXorAssign<ClientOptions> for ClientOptions
impl BitXorAssign<ClientOptions> for ClientOptions
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for ClientOptions
impl Clone for ClientOptions
sourcefn clone(&self) -> ClientOptions
fn clone(&self) -> ClientOptions
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 ClientOptions
impl Debug for ClientOptions
sourceimpl Extend<ClientOptions> for ClientOptions
impl Extend<ClientOptions> for ClientOptions
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<ClientOptions> for ClientOptions
impl FromIterator<ClientOptions> for ClientOptions
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 ClientOptions
impl Hash for ClientOptions
sourceimpl LowerHex for ClientOptions
impl LowerHex for ClientOptions
sourceimpl Not for ClientOptions
impl Not for ClientOptions
sourceimpl Octal for ClientOptions
impl Octal for ClientOptions
sourceimpl Ord for ClientOptions
impl Ord for ClientOptions
sourceimpl PartialEq<ClientOptions> for ClientOptions
impl PartialEq<ClientOptions> for ClientOptions
sourcefn eq(&self, other: &ClientOptions) -> bool
fn eq(&self, other: &ClientOptions) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ClientOptions) -> bool
fn ne(&self, other: &ClientOptions) -> bool
This method tests for !=
.
sourceimpl PartialOrd<ClientOptions> for ClientOptions
impl PartialOrd<ClientOptions> for ClientOptions
sourcefn partial_cmp(&self, other: &ClientOptions) -> Option<Ordering>
fn partial_cmp(&self, other: &ClientOptions) -> 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<ClientOptions> for ClientOptions
impl Sub<ClientOptions> for ClientOptions
sourceimpl SubAssign<ClientOptions> for ClientOptions
impl SubAssign<ClientOptions> for ClientOptions
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for ClientOptions
impl UpperHex for ClientOptions
impl Copy for ClientOptions
impl Eq for ClientOptions
impl StructuralEq for ClientOptions
impl StructuralPartialEq for ClientOptions
Auto Trait Implementations
impl RefUnwindSafe for ClientOptions
impl Send for ClientOptions
impl Sync for ClientOptions
impl Unpin for ClientOptions
impl UnwindSafe for ClientOptions
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