Struct ControlFlags

#[repr(transparent)]
pub struct ControlFlags(/* private field */);

Flags for setting the control mode of a terminal

Implementations

impl ControlFlags

const CS5: Self = _;
const CS6: Self = _;
const CS7: Self = _;
const CS8: Self = _;
const CSTOPB: Self = _;
const CREAD: Self = _;
const PARENB: Self = _;
const PARODD: Self = _;
const HUPCL: Self = _;
const CLOCAL: Self = _;
const CRTSCTS: Self = _;
const CBAUD: Self = _;
const CMSPAR: Self = _;
const CIBAUD: Self = _;
const CBAUDEX: Self = _;
const CSIZE: Self = _;

impl ControlFlags

const fn empty() -> Self

Get a flags value with all bits unset.

const fn all() -> Self

Get a flags value with all known bits set.

const fn bits(&self) -> tcflag_t

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

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.

const fn from_bits_truncate(bits: tcflag_t) -> Self

Convert from a bits value, unsetting any unknown bits.

const fn from_bits_retain(bits: tcflag_t) -> Self

Convert from a bits value exactly.

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.

const fn is_empty(&self) -> bool

Whether all bits in self are unset.

const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

const fn intersects(&self, other: Self) -> bool

Whether any set bits in other are also set in self.

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

Whether all set bits in other are also set in self.

fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in self and other.

fn remove(&mut self, other: Self)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won't truncate other, but the ! operator will.

fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in self and other.

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

Call insert when value is true or remove when value is false.

const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in self and other.

const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in self and other.

const fn difference(self, other: Self) -> Self

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won't truncate other, but the ! operator will.

const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in self and other.

const fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl ControlFlags

const fn iter(&self) -> Iter<ControlFlags>

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.

const fn iter_names(&self) -> IterNames<ControlFlags>

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

impl Binary for ControlFlags

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

impl BitAnd for ControlFlags

type Output = ControlFlags;
fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in self and other.

impl BitAndAssign for ControlFlags

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in self and other.

impl BitOr for ControlFlags

type Output = ControlFlags;
fn bitor(self, other: ControlFlags) -> Self

The bitwise or (|) of the bits in self and other.

impl BitOrAssign for ControlFlags

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in self and other.

impl BitXor for ControlFlags

type Output = ControlFlags;
fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in self and other.

impl BitXorAssign for ControlFlags

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in self and other.

impl Clone for ControlFlags

fn clone(&self) -> Self

impl Copy for ControlFlags

impl Debug for ControlFlags

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

impl Eq for ControlFlags

impl Extend<ControlFlags> for ControlFlags

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

impl Flags for ControlFlags

const FLAGS: &'static [Flag<ControlFlags>] = _;
type Bits = u32;
fn bits(&self) -> tcflag_t
fn from_bits_retain(bits: tcflag_t) -> ControlFlags
fn all_named() -> ControlFlags

impl FromIterator<ControlFlags> for ControlFlags

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

The bitwise or (|) of the bits in each flags value.

impl Hash for ControlFlags

fn hash<__H: Hasher>(&self, state: &mut __H)

impl IntoIterator for ControlFlags

type Item = ControlFlags;
type IntoIter = Iter<ControlFlags>;
fn into_iter(self) -> Self::IntoIter

impl LowerHex for ControlFlags

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

impl Not for ControlFlags

type Output = ControlFlags;
fn not(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl Octal for ControlFlags

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

impl Ord for ControlFlags

fn cmp(&self, other: &Self) -> Ordering

impl PartialEq for ControlFlags

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

impl PartialOrd for ControlFlags

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

impl PublicFlags for ControlFlags

type Primitive = u32;
type Internal = InternalBitFlags;

impl StructuralPartialEq for ControlFlags

impl Sub for ControlFlags

type Output = ControlFlags;
fn sub(self, other: Self) -> Self

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won't truncate other, but the ! operator will.

impl SubAssign for ControlFlags

fn sub_assign(&mut self, other: Self)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won't truncate other, but the ! operator will.

impl UpperHex for ControlFlags

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

Auto Trait Implementations

impl Freeze for ControlFlags

impl RefUnwindSafe for ControlFlags

impl Send for ControlFlags

impl Sync for ControlFlags

impl Unpin for ControlFlags

impl UnsafeUnpin for ControlFlags

impl UnwindSafe for ControlFlags

Blanket Implementations

impl<T> Any for ControlFlags where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for ControlFlags where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for ControlFlags where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for ControlFlags where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for ControlFlags

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> ToOwned for ControlFlags where T: Clone,

type Owned = T;
fn to_owned(&self) -> T
fn clone_into(&self, target: &mut T)

impl<T, U> Into<U> for ControlFlags where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom<U> for ControlFlags where U: Into<T>,

type Error = never;
fn try_from(value: U) -> Result<T, never>

impl<T, U> TryInto<U> for ControlFlags where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error;
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>