Struct jack::ClientOptions
source · pub struct ClientOptions { /* private fields */ }
Expand description
Option flags for opening a JACK client.
Implementations§
source§impl 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§
source§impl Binary for ClientOptions
impl Binary for ClientOptions
source§impl BitAnd<ClientOptions> for ClientOptions
impl BitAnd<ClientOptions> for ClientOptions
source§impl BitAndAssign<ClientOptions> for ClientOptions
impl BitAndAssign<ClientOptions> for ClientOptions
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<ClientOptions> for ClientOptions
impl BitOr<ClientOptions> for ClientOptions
source§fn bitor(self, other: ClientOptions) -> Self
fn bitor(self, other: ClientOptions) -> Self
Returns the union of the two sets of flags.
§type Output = ClientOptions
type Output = ClientOptions
|
operator.source§impl BitOrAssign<ClientOptions> for ClientOptions
impl BitOrAssign<ClientOptions> for ClientOptions
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<ClientOptions> for ClientOptions
impl BitXor<ClientOptions> for ClientOptions
source§impl BitXorAssign<ClientOptions> for ClientOptions
impl BitXorAssign<ClientOptions> for ClientOptions
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for ClientOptions
impl Clone for ClientOptions
source§fn clone(&self) -> ClientOptions
fn clone(&self) -> ClientOptions
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ClientOptions
impl Debug for ClientOptions
source§impl Extend<ClientOptions> for ClientOptions
impl Extend<ClientOptions> for ClientOptions
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl FromIterator<ClientOptions> for ClientOptions
impl FromIterator<ClientOptions> for ClientOptions
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for ClientOptions
impl Hash for ClientOptions
source§impl LowerHex for ClientOptions
impl LowerHex for ClientOptions
source§impl Not for ClientOptions
impl Not for ClientOptions
source§impl Octal for ClientOptions
impl Octal for ClientOptions
source§impl Ord for ClientOptions
impl Ord for ClientOptions
source§fn cmp(&self, other: &ClientOptions) -> Ordering
fn cmp(&self, other: &ClientOptions) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq<ClientOptions> for ClientOptions
impl PartialEq<ClientOptions> for ClientOptions
source§fn eq(&self, other: &ClientOptions) -> bool
fn eq(&self, other: &ClientOptions) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd<ClientOptions> for ClientOptions
impl PartialOrd<ClientOptions> for ClientOptions
source§fn partial_cmp(&self, other: &ClientOptions) -> Option<Ordering>
fn partial_cmp(&self, other: &ClientOptions) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Sub<ClientOptions> for ClientOptions
impl Sub<ClientOptions> for ClientOptions
source§impl SubAssign<ClientOptions> for ClientOptions
impl SubAssign<ClientOptions> for ClientOptions
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.