pub struct InputFlags { /* private fields */ }
Expand description
Flags for configuring the input mode of a terminal
Implementations
impl InputFlags
impl InputFlags
pub const IGNBRK: InputFlags = Self{bits: libc::IGNBRK,}
pub const BRKINT: InputFlags = Self{bits: libc::BRKINT,}
pub const IGNPAR: InputFlags = Self{bits: libc::IGNPAR,}
pub const PARMRK: InputFlags = Self{bits: libc::PARMRK,}
pub const INPCK: InputFlags = Self{bits: libc::INPCK,}
pub const ISTRIP: InputFlags = Self{bits: libc::ISTRIP,}
pub const INLCR: InputFlags = Self{bits: libc::INLCR,}
pub const IGNCR: InputFlags = Self{bits: libc::IGNCR,}
pub const ICRNL: InputFlags = Self{bits: libc::ICRNL,}
pub const IXON: InputFlags = Self{bits: libc::IXON,}
pub const IXOFF: InputFlags = Self{bits: libc::IXOFF,}
pub const IXANY: InputFlags = Self{bits: libc::IXANY,}
pub const IMAXBEL: InputFlags = Self{bits: libc::IMAXBEL,}
pub const IUTF8: InputFlags = Self{bits: libc::IUTF8,}
pub const fn empty() -> InputFlags
pub const fn empty() -> InputFlags
Returns an empty set of flags.
pub const fn all() -> InputFlags
pub const fn all() -> InputFlags
Returns the set containing all flags.
pub const fn from_bits(bits: u32) -> Option<InputFlags>
pub const fn from_bits(bits: u32) -> Option<InputFlags>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
pub const fn from_bits_truncate(bits: u32) -> InputFlags
pub const fn from_bits_truncate(bits: u32) -> InputFlags
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
pub const unsafe fn from_bits_unchecked(bits: u32) -> InputFlags
pub const unsafe fn from_bits_unchecked(bits: u32) -> InputFlags
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.
pub const fn intersects(&self, other: InputFlags) -> bool
pub const fn intersects(&self, other: InputFlags) -> bool
Returns true
if there are flags common to both self
and other
.
pub const fn contains(&self, other: InputFlags) -> bool
pub const fn contains(&self, other: InputFlags) -> bool
Returns true
if all of the flags in other
are contained within self
.
pub fn insert(&mut self, other: InputFlags)
pub fn insert(&mut self, other: InputFlags)
Inserts the specified flags in-place.
pub fn remove(&mut self, other: InputFlags)
pub fn remove(&mut self, other: InputFlags)
Removes the specified flags in-place.
pub fn toggle(&mut self, other: InputFlags)
pub fn toggle(&mut self, other: InputFlags)
Toggles the specified flags in-place.
pub fn set(&mut self, other: InputFlags, value: bool)
pub fn set(&mut self, other: InputFlags, value: bool)
Inserts or removes the specified flags depending on the passed value.
pub const fn intersection(self, other: InputFlags) -> InputFlags
pub const fn intersection(self, other: InputFlags) -> InputFlags
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
.
pub const fn union(self, other: InputFlags) -> InputFlags
pub const fn union(self, other: InputFlags) -> InputFlags
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
.
pub const fn difference(self, other: InputFlags) -> InputFlags
pub const fn difference(self, other: InputFlags) -> InputFlags
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
.
pub const fn symmetric_difference(self, other: InputFlags) -> InputFlags
pub const fn symmetric_difference(self, other: InputFlags) -> InputFlags
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
.
pub const fn complement(self) -> InputFlags
pub const fn complement(self) -> InputFlags
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
impl Binary for InputFlags
impl Binary for InputFlags
impl BitAnd<InputFlags> for InputFlags
impl BitAnd<InputFlags> for InputFlags
fn bitand(self, other: InputFlags) -> InputFlags
fn bitand(self, other: InputFlags) -> InputFlags
Returns the intersection between the two sets of flags.
type Output = InputFlags
type Output = InputFlags
The resulting type after applying the &
operator.
impl BitAndAssign<InputFlags> for InputFlags
impl BitAndAssign<InputFlags> for InputFlags
fn bitand_assign(&mut self, other: InputFlags)
fn bitand_assign(&mut self, other: InputFlags)
Disables all flags disabled in the set.
impl BitOr<InputFlags> for InputFlags
impl BitOr<InputFlags> for InputFlags
fn bitor(self, other: InputFlags) -> InputFlags
fn bitor(self, other: InputFlags) -> InputFlags
Returns the union of the two sets of flags.
type Output = InputFlags
type Output = InputFlags
The resulting type after applying the |
operator.
impl BitOrAssign<InputFlags> for InputFlags
impl BitOrAssign<InputFlags> for InputFlags
fn bitor_assign(&mut self, other: InputFlags)
fn bitor_assign(&mut self, other: InputFlags)
Adds the set of flags.
impl BitXor<InputFlags> for InputFlags
impl BitXor<InputFlags> for InputFlags
fn bitxor(self, other: InputFlags) -> InputFlags
fn bitxor(self, other: InputFlags) -> InputFlags
Returns the left flags, but with all the right flags toggled.
type Output = InputFlags
type Output = InputFlags
The resulting type after applying the ^
operator.
impl BitXorAssign<InputFlags> for InputFlags
impl BitXorAssign<InputFlags> for InputFlags
fn bitxor_assign(&mut self, other: InputFlags)
fn bitxor_assign(&mut self, other: InputFlags)
Toggles the set of flags.
impl Clone for InputFlags
impl Clone for InputFlags
fn clone(&self) -> InputFlags
fn clone(&self) -> InputFlags
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
impl Debug for InputFlags
impl Debug for InputFlags
impl Extend<InputFlags> for InputFlags
impl Extend<InputFlags> for InputFlags
fn extend<T>(&mut self, iterator: T) where
T: IntoIterator<Item = InputFlags>,
fn extend<T>(&mut self, iterator: T) where
T: IntoIterator<Item = InputFlags>,
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
impl FromIterator<InputFlags> for InputFlags
impl FromIterator<InputFlags> for InputFlags
fn from_iter<T>(iterator: T) -> InputFlags where
T: IntoIterator<Item = InputFlags>,
fn from_iter<T>(iterator: T) -> InputFlags where
T: IntoIterator<Item = InputFlags>,
Creates a value from an iterator. Read more
impl Hash for InputFlags
impl Hash for InputFlags
impl LowerHex for InputFlags
impl LowerHex for InputFlags
impl Not for InputFlags
impl Not for InputFlags
fn not(self) -> InputFlags
fn not(self) -> InputFlags
Returns the complement of this set of flags.
type Output = InputFlags
type Output = InputFlags
The resulting type after applying the !
operator.
impl Octal for InputFlags
impl Octal for InputFlags
impl Ord for InputFlags
impl Ord for InputFlags
impl PartialEq<InputFlags> for InputFlags
impl PartialEq<InputFlags> for InputFlags
fn eq(&self, other: &InputFlags) -> bool
fn eq(&self, other: &InputFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
fn ne(&self, other: &InputFlags) -> bool
fn ne(&self, other: &InputFlags) -> bool
This method tests for !=
.
impl PartialOrd<InputFlags> for InputFlags
impl PartialOrd<InputFlags> for InputFlags
fn partial_cmp(&self, other: &InputFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &InputFlags) -> 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
impl Sub<InputFlags> for InputFlags
impl Sub<InputFlags> for InputFlags
fn sub(self, other: InputFlags) -> InputFlags
fn sub(self, other: InputFlags) -> InputFlags
Returns the set difference of the two sets of flags.
type Output = InputFlags
type Output = InputFlags
The resulting type after applying the -
operator.
impl SubAssign<InputFlags> for InputFlags
impl SubAssign<InputFlags> for InputFlags
fn sub_assign(&mut self, other: InputFlags)
fn sub_assign(&mut self, other: InputFlags)
Disables all flags enabled in the set.
impl UpperHex for InputFlags
impl UpperHex for InputFlags
impl Copy for InputFlags
impl Eq for InputFlags
impl StructuralEq for InputFlags
impl StructuralPartialEq for InputFlags
Auto Trait Implementations
impl RefUnwindSafe for InputFlags
impl Send for InputFlags
impl Sync for InputFlags
impl Unpin for InputFlags
impl UnwindSafe for InputFlags
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> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
sourcefn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<W, Global>impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<W, Global>impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
W: Write + ?Sized, impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
sourcefn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
sourcefn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
sourcefn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
sourceimpl<T> DowncastSync for T where
T: Any + Send + Sync,
impl<T> DowncastSync for T where
T: Any + Send + Sync,
sourceimpl<A> DynCastExt for A
impl<A> DynCastExt for A
sourcefn dyn_cast<T>(
self
) -> Result<<A as DynCastExtHelper<T>>::Target, <A as DynCastExtHelper<T>>::Source> where
A: DynCastExtHelper<T>,
T: ?Sized,
fn dyn_cast<T>(
self
) -> Result<<A as DynCastExtHelper<T>>::Target, <A as DynCastExtHelper<T>>::Source> where
A: DynCastExtHelper<T>,
T: ?Sized,
Use this to cast from one trait object type to another. Read more
sourcefn dyn_upcast<T>(self) -> <A as DynCastExtAdvHelper<T, T>>::Target where
A: DynCastExtAdvHelper<T, T, Source = <A as DynCastExtAdvHelper<T, T>>::Target>,
T: ?Sized,
fn dyn_upcast<T>(self) -> <A as DynCastExtAdvHelper<T, T>>::Target where
A: DynCastExtAdvHelper<T, T, Source = <A as DynCastExtAdvHelper<T, T>>::Target>,
T: ?Sized,
Use this to upcast a trait to one of its supertraits. Read more
sourcefn dyn_cast_adv<F, T>(
self
) -> Result<<A as DynCastExtAdvHelper<F, T>>::Target, <A as DynCastExtAdvHelper<F, T>>::Source> where
A: DynCastExtAdvHelper<F, T>,
F: ?Sized,
T: ?Sized,
fn dyn_cast_adv<F, T>(
self
) -> Result<<A as DynCastExtAdvHelper<F, T>>::Target, <A as DynCastExtAdvHelper<F, T>>::Source> where
A: DynCastExtAdvHelper<F, T>,
F: ?Sized,
T: ?Sized,
sourcefn dyn_cast_with_config<C>(
self
) -> Result<<A as DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>>::Target, <A as DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>>::Source> where
C: DynCastConfig,
A: DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>,
fn dyn_cast_with_config<C>(
self
) -> Result<<A as DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>>::Target, <A as DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>>::Source> where
C: DynCastConfig,
A: DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>,
Use this to cast from one trait object type to another. With this method the type parameter is a config type that uniquely specifies which cast should be preformed. Read more