pub struct UnionFlags(/* private fields */);Expand description
Flags representing various properties of a type union.
This replaces 9 individual boolean fields with a compact 16-bit representation, reducing memory usage from 9 bytes to 2 bytes per TUnion instance.
Implementations§
Source§impl UnionFlags
impl UnionFlags
Sourcepub const HAD_TEMPLATE: UnionFlags
pub const HAD_TEMPLATE: UnionFlags
Indicates the union had a template type at some point.
Sourcepub const BY_REFERENCE: UnionFlags
pub const BY_REFERENCE: UnionFlags
Indicates the value is passed by reference.
Sourcepub const REFERENCE_FREE: UnionFlags
pub const REFERENCE_FREE: UnionFlags
Indicates no references exist to this type.
Sourcepub const POSSIBLY_UNDEFINED_FROM_TRY: UnionFlags
pub const POSSIBLY_UNDEFINED_FROM_TRY: UnionFlags
Indicates the type may be undefined due to a try block.
Sourcepub const POSSIBLY_UNDEFINED: UnionFlags
pub const POSSIBLY_UNDEFINED: UnionFlags
Indicates the type may be undefined.
Sourcepub const IGNORE_NULLABLE_ISSUES: UnionFlags
pub const IGNORE_NULLABLE_ISSUES: UnionFlags
Indicates nullable issues should be ignored for this type.
Sourcepub const IGNORE_FALSABLE_ISSUES: UnionFlags
pub const IGNORE_FALSABLE_ISSUES: UnionFlags
Indicates falsable issues should be ignored for this type.
Sourcepub const FROM_TEMPLATE_DEFAULT: UnionFlags
pub const FROM_TEMPLATE_DEFAULT: UnionFlags
Indicates the type came from a template default value.
Sourcepub const POPULATED: UnionFlags
pub const POPULATED: UnionFlags
Indicates the type has been populated with codebase information.
Sourcepub const NULLSAFE_NULL: UnionFlags
pub const NULLSAFE_NULL: UnionFlags
Indicates the null in this union came from nullsafe short-circuit.
Source§impl UnionFlags
impl UnionFlags
pub const fn empty() -> Self
pub const fn insert(&mut self, flag: UnionFlags)
pub const fn set(&mut self, flag: UnionFlags, value: bool)
pub const fn contains(self, flag: UnionFlags) -> bool
pub const fn intersects(self, other: UnionFlags) -> bool
pub const fn union(&self, other: UnionFlags) -> UnionFlags
pub const fn intersection(&self, other: UnionFlags) -> UnionFlags
Trait Implementations§
Source§impl BitAnd for UnionFlags
impl BitAnd for UnionFlags
Source§impl BitAndAssign for UnionFlags
impl BitAndAssign for UnionFlags
Source§fn bitand_assign(&mut self, rhs: Self)
fn bitand_assign(&mut self, rhs: Self)
&= operation. Read moreSource§impl BitOr for UnionFlags
impl BitOr for UnionFlags
Source§impl BitOrAssign for UnionFlags
impl BitOrAssign for UnionFlags
Source§fn bitor_assign(&mut self, rhs: Self)
fn bitor_assign(&mut self, rhs: Self)
|= operation. Read moreSource§impl Clone for UnionFlags
impl Clone for UnionFlags
Source§fn clone(&self) -> UnionFlags
fn clone(&self) -> UnionFlags
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for UnionFlags
impl Debug for UnionFlags
Source§impl Default for UnionFlags
impl Default for UnionFlags
Source§fn default() -> UnionFlags
fn default() -> UnionFlags
Source§impl<'de> Deserialize<'de> for UnionFlags
impl<'de> Deserialize<'de> for UnionFlags
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl Hash for UnionFlags
impl Hash for UnionFlags
Source§impl Not for UnionFlags
impl Not for UnionFlags
Source§impl Ord for UnionFlags
impl Ord for UnionFlags
Source§fn cmp(&self, other: &UnionFlags) -> Ordering
fn cmp(&self, other: &UnionFlags) -> Ordering
1.21.0 · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Source§impl PartialEq for UnionFlags
impl PartialEq for UnionFlags
Source§impl PartialOrd for UnionFlags
impl PartialOrd for UnionFlags
Source§impl Serialize for UnionFlags
impl Serialize for UnionFlags
impl Copy for UnionFlags
impl Eq for UnionFlags
impl StructuralPartialEq for UnionFlags
Auto Trait Implementations§
impl Freeze for UnionFlags
impl RefUnwindSafe for UnionFlags
impl Send for UnionFlags
impl Sync for UnionFlags
impl Unpin for UnionFlags
impl UnsafeUnpin for UnionFlags
impl UnwindSafe for UnionFlags
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§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);