Struct OutputFlags

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

Flags for configuring the output mode of a terminal

Implementations

impl OutputFlags

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

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

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.

impl OutputFlags

const OPOST: Self = _;
const OLCUC: Self = _;
const ONLCR: Self = _;
const OCRNL: Self = _;
const ONOCR: Self = _;
const ONLRET: Self = _;
const OFDEL: Self = _;
const OFILL: Self = _;
const NL0: Self = _;
const NL1: Self = _;
const CR0: Self = _;
const CR1: Self = _;
const CR2: Self = _;
const CR3: Self = _;
const TAB0: Self = _;
const TAB1: Self = _;
const TAB2: Self = _;
const TAB3: Self = _;
const XTABS: Self = _;
const BS0: Self = _;
const BS1: Self = _;
const VT0: Self = _;
const VT1: Self = _;
const FF0: Self = _;
const FF1: Self = _;
const NLDLY: Self = _;
const CRDLY: Self = _;
const TABDLY: Self = _;
const BSDLY: Self = _;
const VTDLY: Self = _;
const FFDLY: Self = _;

impl OutputFlags

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.

Trait Implementations

impl Binary for OutputFlags

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

impl BitAnd for OutputFlags

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

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

impl BitAndAssign for OutputFlags

fn bitand_assign(&mut self, other: Self)

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

impl BitOr for OutputFlags

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

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

impl BitOrAssign for OutputFlags

fn bitor_assign(&mut self, other: Self)

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

impl BitXor for OutputFlags

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

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

impl BitXorAssign for OutputFlags

fn bitxor_assign(&mut self, other: Self)

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

impl Clone for OutputFlags

fn clone(&self) -> Self

impl Copy for OutputFlags

impl Debug for OutputFlags

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

impl Eq for OutputFlags

impl Extend<OutputFlags> for OutputFlags

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

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

impl Flags for OutputFlags

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

impl FromIterator<OutputFlags> for OutputFlags

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

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

impl Hash for OutputFlags

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

impl IntoIterator for OutputFlags

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

impl LowerHex for OutputFlags

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

impl Not for OutputFlags

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

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

impl Octal for OutputFlags

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

impl Ord for OutputFlags

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

impl PartialEq for OutputFlags

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

impl PartialOrd for OutputFlags

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

impl PublicFlags for OutputFlags

type Primitive = u32;
type Internal = InternalBitFlags;

impl StructuralPartialEq for OutputFlags

impl Sub for OutputFlags

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

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 OutputFlags

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

Auto Trait Implementations

impl Freeze for OutputFlags

impl RefUnwindSafe for OutputFlags

impl Send for OutputFlags

impl Sync for OutputFlags

impl Unpin for OutputFlags

impl UnsafeUnpin for OutputFlags

impl UnwindSafe for OutputFlags

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

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

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

impl<T> From<T> for OutputFlags

fn from(t: T) -> T

Returns the argument unchanged.

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

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

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

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

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

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