pub struct ControlBits { /* private fields */ }
Expand description
The control bits of a device. These are defined in the RS-232 standard.
Implementations
sourceimpl ControlBits
impl ControlBits
sourcepub const CLEAR_TO_SEND: Self
pub const CLEAR_TO_SEND: Self
Clear to send
sourcepub const DATA_SET_READY: Self
pub const DATA_SET_READY: Self
Data set ready
sourcepub const RING_INDICATE: Self
pub const RING_INDICATE: Self
Indicates that a phone line is ringing
sourcepub const CARRIER_DETECT: Self
pub const CARRIER_DETECT: Self
Indicates the connection is still connected
sourcepub const INPUT_BUFFER_EMPTY: Self
pub const INPUT_BUFFER_EMPTY: Self
The input buffer is empty
sourcepub const OUTPUT_BUFFER_EMPTY: Self
pub const OUTPUT_BUFFER_EMPTY: Self
The output buffer is empty
sourcepub const DATA_TERMINAL_READY: Self
pub const DATA_TERMINAL_READY: Self
Terminal is ready for communications
sourcepub const REQUEST_TO_SEND: Self
pub const REQUEST_TO_SEND: Self
Request the device to send data
sourcepub const HARDWARE_LOOPBACK_ENABLE: Self
pub const HARDWARE_LOOPBACK_ENABLE: Self
Enable hardware loop-back
sourcepub const SOFTWARE_LOOPBACK_ENABLE: Self
pub const SOFTWARE_LOOPBACK_ENABLE: Self
Enable software loop-back
sourcepub const HARDWARE_FLOW_CONTROL_ENABLE: Self
pub const HARDWARE_FLOW_CONTROL_ENABLE: Self
Allow the hardware to handle flow control
sourcepub const SETTABLE: Self
pub const SETTABLE: Self
Bitmask of the control bits that can be set.
Up to date as of UEFI 2.7 / Serial protocol v1
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> 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: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
pub const unsafe fn from_bits_unchecked(bits: u32) -> 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 ControlBits
impl Binary for ControlBits
sourceimpl BitAnd<ControlBits> for ControlBits
impl BitAnd<ControlBits> for ControlBits
sourceimpl BitAndAssign<ControlBits> for ControlBits
impl BitAndAssign<ControlBits> for ControlBits
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<ControlBits> for ControlBits
impl BitOr<ControlBits> for ControlBits
sourcefn bitor(self, other: ControlBits) -> Self
fn bitor(self, other: ControlBits) -> 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<ControlBits> for ControlBits
impl BitOrAssign<ControlBits> for ControlBits
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<ControlBits> for ControlBits
impl BitXor<ControlBits> for ControlBits
sourceimpl BitXorAssign<ControlBits> for ControlBits
impl BitXorAssign<ControlBits> for ControlBits
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for ControlBits
impl Clone for ControlBits
sourcefn clone(&self) -> ControlBits
fn clone(&self) -> ControlBits
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 ControlBits
impl Debug for ControlBits
sourceimpl Extend<ControlBits> for ControlBits
impl Extend<ControlBits> for ControlBits
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<ControlBits> for ControlBits
impl FromIterator<ControlBits> for ControlBits
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 ControlBits
impl Hash for ControlBits
sourceimpl LowerHex for ControlBits
impl LowerHex for ControlBits
sourceimpl Not for ControlBits
impl Not for ControlBits
sourceimpl Octal for ControlBits
impl Octal for ControlBits
sourceimpl Ord for ControlBits
impl Ord for ControlBits
sourceimpl PartialEq<ControlBits> for ControlBits
impl PartialEq<ControlBits> for ControlBits
sourcefn eq(&self, other: &ControlBits) -> bool
fn eq(&self, other: &ControlBits) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ControlBits) -> bool
fn ne(&self, other: &ControlBits) -> bool
This method tests for !=
.
sourceimpl PartialOrd<ControlBits> for ControlBits
impl PartialOrd<ControlBits> for ControlBits
sourcefn partial_cmp(&self, other: &ControlBits) -> Option<Ordering>
fn partial_cmp(&self, other: &ControlBits) -> 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<ControlBits> for ControlBits
impl Sub<ControlBits> for ControlBits
sourceimpl SubAssign<ControlBits> for ControlBits
impl SubAssign<ControlBits> for ControlBits
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for ControlBits
impl UpperHex for ControlBits
impl Copy for ControlBits
impl Eq for ControlBits
impl StructuralEq for ControlBits
impl StructuralPartialEq for ControlBits
Auto Trait Implementations
impl RefUnwindSafe for ControlBits
impl Send for ControlBits
impl Sync for ControlBits
impl Unpin for ControlBits
impl UnwindSafe for ControlBits
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
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.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more