Struct rustix::termios::ControlModes
source · pub struct ControlModes(/* private fields */);
Expand description
Flags controlling special terminal modes.
CBAUD
, CBAUDEX
, CIBAUD
, and CIBAUDEX
are not defined here,
because they’re handled automatically by Termios::set_speed
and
related functions.
Implementations§
source§impl ControlModes
impl ControlModes
source§impl ControlModes
impl ControlModes
sourcepub const fn bits(&self) -> tcflag_t
pub const fn bits(&self) -> tcflag_t
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: tcflag_t) -> Option<Self>
pub const fn from_bits(bits: tcflag_t) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: tcflag_t) -> Self
pub const fn from_bits_truncate(bits: tcflag_t) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: tcflag_t) -> Self
pub const fn from_bits_retain(bits: tcflag_t) -> Self
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set.
This method will return None
if name
is empty or doesn’t
correspond to any named flag.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
remove
won’t truncate other
, but the !
operator will.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl ControlModes
impl ControlModes
sourcepub const fn iter(&self) -> Iter<ControlModes>
pub const fn iter(&self) -> Iter<ControlModes>
Yield a set of contained flags values.
Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.
sourcepub const fn iter_names(&self) -> IterNames<ControlModes>
pub const fn iter_names(&self) -> IterNames<ControlModes>
Yield a set of contained named flags values.
This method is like iter
, except only yields bits in contained named flags.
Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
Trait Implementations§
source§impl Binary for ControlModes
impl Binary for ControlModes
source§impl BitAnd for ControlModes
impl BitAnd for ControlModes
source§impl BitAndAssign for ControlModes
impl BitAndAssign for ControlModes
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for ControlModes
impl BitOr for ControlModes
source§fn bitor(self, other: ControlModes) -> Self
fn bitor(self, other: ControlModes) -> Self
The bitwise or (|
) of the bits in two flags values.
source§type Output = ControlModes
type Output = ControlModes
|
operator.source§impl BitOrAssign for ControlModes
impl BitOrAssign for ControlModes
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for ControlModes
impl BitXor for ControlModes
source§impl BitXorAssign for ControlModes
impl BitXorAssign for ControlModes
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Clone for ControlModes
impl Clone for ControlModes
source§fn clone(&self) -> ControlModes
fn clone(&self) -> ControlModes
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ControlModes
impl Debug for ControlModes
source§impl Extend<ControlModes> for ControlModes
impl Extend<ControlModes> for ControlModes
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|
) of the bits in each flags value.
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 Flags for ControlModes
impl Flags for ControlModes
source§const FLAGS: &'static [Flag<ControlModes>] = _
const FLAGS: &'static [Flag<ControlModes>] = _
source§fn from_bits_retain(bits: tcflag_t) -> ControlModes
fn from_bits_retain(bits: tcflag_t) -> ControlModes
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moresource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moresource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl FromIterator<ControlModes> for ControlModes
impl FromIterator<ControlModes> for ControlModes
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
source§impl Hash for ControlModes
impl Hash for ControlModes
source§impl IntoIterator for ControlModes
impl IntoIterator for ControlModes
source§impl LowerHex for ControlModes
impl LowerHex for ControlModes
source§impl Not for ControlModes
impl Not for ControlModes
source§impl Octal for ControlModes
impl Octal for ControlModes
source§impl PartialEq for ControlModes
impl PartialEq for ControlModes
source§impl PublicFlags for ControlModes
impl PublicFlags for ControlModes
source§impl Sub for ControlModes
impl Sub for ControlModes
source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
source§type Output = ControlModes
type Output = ControlModes
-
operator.source§impl SubAssign for ControlModes
impl SubAssign for ControlModes
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
source§impl UpperHex for ControlModes
impl UpperHex for ControlModes
impl Copy for ControlModes
impl Eq for ControlModes
impl StructuralPartialEq for ControlModes
Auto Trait Implementations§
impl Freeze for ControlModes
impl RefUnwindSafe for ControlModes
impl Send for ControlModes
impl Sync for ControlModes
impl Unpin for ControlModes
impl UnwindSafe for ControlModes
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)