Struct InputFlags

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

Flags for configuring the input mode of a terminal

Implementations

impl InputFlags

const IGNBRK: Self = _;
const BRKINT: Self = _;
const IGNPAR: Self = _;
const PARMRK: Self = _;
const INPCK: Self = _;
const ISTRIP: Self = _;
const INLCR: Self = _;
const IGNCR: Self = _;
const ICRNL: Self = _;
const IXON: Self = _;
const IXOFF: Self = _;
const IUCLC: Self = _;
const IXANY: Self = _;
const IMAXBEL: Self = _;
const IUTF8: Self = _;

impl InputFlags

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 InputFlags

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

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<InputFlags>

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 InputFlags

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

impl BitAnd for InputFlags

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

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

impl BitAndAssign for InputFlags

fn bitand_assign(&mut self, other: Self)

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

impl BitOr for InputFlags

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

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

impl BitOrAssign for InputFlags

fn bitor_assign(&mut self, other: Self)

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

impl BitXor for InputFlags

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

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

impl BitXorAssign for InputFlags

fn bitxor_assign(&mut self, other: Self)

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

impl Clone for InputFlags

fn clone(&self) -> Self

impl Copy for InputFlags

impl Debug for InputFlags

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

impl Eq for InputFlags

impl Extend<InputFlags> for InputFlags

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

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

impl Flags for InputFlags

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

impl FromIterator<InputFlags> for InputFlags

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

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

impl Hash for InputFlags

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

impl IntoIterator for InputFlags

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

impl LowerHex for InputFlags

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

impl Not for InputFlags

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

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

impl Octal for InputFlags

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

impl Ord for InputFlags

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

impl PartialEq for InputFlags

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

impl PartialOrd for InputFlags

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

impl PublicFlags for InputFlags

type Primitive = u32;
type Internal = InternalBitFlags;

impl StructuralPartialEq for InputFlags

impl Sub for InputFlags

type Output = InputFlags;
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 InputFlags

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 InputFlags

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

Auto Trait Implementations

impl Freeze for InputFlags

impl RefUnwindSafe for InputFlags

impl Send for InputFlags

impl Sync for InputFlags

impl Unpin for InputFlags

impl UnsafeUnpin for InputFlags

impl UnwindSafe for InputFlags

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

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

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

impl<T> From<T> for InputFlags

fn from(t: T) -> T

Returns the argument unchanged.

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

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

impl<T, U> Into<U> for InputFlags 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 InputFlags where U: Into<T>,

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

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

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