Struct TileFlags 

pub struct TileFlags(/* private fields */);

Bit-flags tracking a tile’s emptiness and its role in any multi-cell structure it is part of: a wide character, or a span.

Implementations

impl TileFlags

pub const WIDE_CHAR: Self

This tile is the left half of a 2-column wide character.

pub const WIDE_CHAR_SPACER: Self

This tile is the invisible right-half spacer of a wide character.

pub const EMPTY: Self

No content has been written to this tile: it is fully transparent.

Set on Tile::default and cleared by every write. Compositing (Grid::blit, layer flattening) skips empty tiles, so an explicit space (which is not empty) is opaque and overwrites lower layers, while an untouched cell is not.

pub const HAS_EXTRA: Self

This tile has an entry in its layer’s sparse EGC side-table (see Grid’s internal LayerBuf::extras), because it holds a multi-codepoint grapheme cluster (combining marks, ZWJ sequences).

This flag is authoritative for whether extra text exists: code that reads a tile’s grapheme must check this bit first and treat the side-table as backing storage only, never the other way around. Tile cannot carry the string itself and stay small (see Grid::grapheme); the split is what keeps the common single-codepoint tile compact.

pub const SPAN_ANCHOR: Self

This tile is the top-left anchor of a multi-cell span: it occupies Tile::span cells, not one.

Written only by Grid::write_span, which also writes the matching SPAN_COVERED tiles. An anchor without its covered cells is a broken invariant, which is why there is no Tile builder for this flag.

pub const SPAN_COVERED: Self

This tile is covered by a multi-cell span anchored above and/or to its left; see Tile::span_offset.

Unlike WIDE_CHAR_SPACER, a covered tile keeps a real glyph and is rendered by cell backends: that glyph is the span artwork’s text fallback. Only a backend that actually draws the span’s artwork (a pixel backend blitting one sprite across the whole footprint) skips it. See the grid module docs for the full contract.

impl TileFlags

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u8

Get the underlying bits value.

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

pub const fn from_bits(bits: u8) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u8) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u8) -> Self

Convert from a bits value exactly.

pub 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.

pub const fn is_empty(&self) -> bool

Whether all bits in self are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

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

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

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

pub fn insert(&mut self, other: Self)

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

pub 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.

pub fn toggle(&mut self, other: Self)

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

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

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

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

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

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

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

pub 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.

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

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

pub const fn complement(self) -> Self

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

impl TileFlags

pub const fn iter(&self) -> Iter<TileFlags>

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.

pub const fn iter_names(&self) -> IterNames<TileFlags>

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 TileFlags

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

Formats the value using the given formatter.

impl BitAnd for TileFlags

fn bitand(self, other: Self) -> Self

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

type Output = TileFlags

The resulting type after applying the & operator.

impl BitAndAssign for TileFlags

fn bitand_assign(&mut self, other: Self)

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

impl BitOr for TileFlags

fn bitor(self, other: TileFlags) -> Self

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

type Output = TileFlags

The resulting type after applying the | operator.

impl BitOrAssign for TileFlags

fn bitor_assign(&mut self, other: Self)

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

impl BitXor for TileFlags

fn bitxor(self, other: Self) -> Self

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

type Output = TileFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for TileFlags

fn bitxor_assign(&mut self, other: Self)

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

impl Clone for TileFlags

fn clone(&self) -> TileFlags

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for TileFlags

impl Debug for TileFlags

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

Formats the value using the given formatter.

impl Default for TileFlags

fn default() -> TileFlags

Returns the “default value” for a type.

impl Eq for TileFlags

impl Extend<TileFlags> for TileFlags

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

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

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for TileFlags

const FLAGS: &'static [Flag<TileFlags>]

The set of defined flags.

type Bits = u8

The underlying bits type.

fn bits(&self) -> u8

Get the underlying bits value.

fn from_bits_retain(bits: u8) -> TileFlags

Convert from a bits value exactly.

fn all_named() -> TileFlags

Get a flags value with all bits from named flags set.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn known_bits(&self) -> Self::Bits

Get the known bits from a flags value.

fn unknown_bits(&self) -> Self::Bits

Get the unknown bits from a flags value.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by Self::FLAGS.

fn iter_equal_names(&self) -> IterEqualNames<Self>

Get an iterator over all defined names for this flags value.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

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

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

where Self: Sized,

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

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

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

fn remove(&mut self, other: Self)

where Self: Sized,

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

fn toggle(&mut self, other: Self)

where Self: Sized,

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

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

where Self: Sized,

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

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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

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

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

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

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

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

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

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

fn complement(self) -> Self

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

impl FromIterator<TileFlags> for TileFlags

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

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

impl Hash for TileFlags

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

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for TileFlags

type Item = TileFlags

The type of the elements being iterated over.

type IntoIter = Iter<TileFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for TileFlags

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

Formats the value using the given formatter.

impl Not for TileFlags

fn not(self) -> Self

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

type Output = TileFlags

The resulting type after applying the ! operator.

impl Octal for TileFlags

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

Formats the value using the given formatter.

impl PartialEq for TileFlags

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PublicFlags for TileFlags

type Primitive = u8

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl StructuralPartialEq for TileFlags

impl Sub for TileFlags

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.

type Output = TileFlags

The resulting type after applying the - operator.

impl SubAssign for TileFlags

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 TileFlags

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

Formats the value using the given formatter.