Struct tiger_lib::game::GameFlags

pub struct GameFlags(_);

A set of bitflags to indicate for which game something is intended, independent of which game we are validating.

This way, error messages about things being used in the wrong game can be given at runtime.

Implementations

impl GameFlags

pub const Ck3: Self = _

pub const Vic3: Self = _

pub const Imperator: Self = _

impl GameFlags

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

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

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

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

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

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

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

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

Get the value for a flag from its stringified name.

Names are case-sensitive, so must correspond exactly to the identifier given to the flag.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

Returns true if there are flags common to both self and other.

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

Returns true if all of the flags in other are contained within self.

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

Inserts the specified flags in-place.

This method is equivalent to union.

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

Removes the specified flags in-place.

This method is equivalent to difference.

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

Toggles the specified flags in-place.

This method is equivalent to symmetric_difference.

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

Inserts or removes the specified flags depending on the passed value.

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

Returns the intersection between the flags in self and other.

Calculating self bitwise and (&) other, including any bits that don’t correspond to a defined flag.

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

Returns the union of between the flags in self and other.

Calculates self bitwise or (|) other, including any bits that don’t correspond to a defined flag.

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

Returns the difference between the flags in self and other.

Calculates self bitwise and (&!) the bitwise negation of other, including any bits that don’t correspond to a defined flag.

This method is not equivalent to a & !b when there are bits set that don’t correspond to a defined flag. The ! operator will unset any bits that don’t correspond to a flag, so they’ll always be unset by a &! b, but respected by a.difference(b).

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

Returns the symmetric difference between the flags in self and other.

Calculates self bitwise exclusive or (^) other, including any bits that don’t correspond to a defined flag.

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Calculates the bitwise negation (!) of self, unsetting any bits that don’t correspond to a defined flag.

impl GameFlags

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

Iterate over enabled flag values.

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

Iterate over enabled flag values with their stringified names.

impl GameFlags

pub fn game() -> Self

Get a GameFlags value representing the game being validated. Useful for checking with .contains.

Trait Implementations

impl Binary for GameFlags

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

Formats the value using the given formatter.

impl BitAnd<GameFlags> for GameFlags

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

Returns the intersection between the two sets of flags.

type Output = GameFlags

The resulting type after applying the & operator.

impl BitAndAssign<GameFlags> for GameFlags

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<GameFlags> for GameFlags

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

Returns the union of the two sets of flags.

type Output = GameFlags

The resulting type after applying the | operator.

impl BitOrAssign<GameFlags> for GameFlags

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<GameFlags> for GameFlags

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

Returns the left flags, but with all the right flags toggled.

type Output = GameFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<GameFlags> for GameFlags

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for GameFlags

fn clone(&self) -> GameFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GameFlags

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

Formats the value using the given formatter.

impl Display for GameFlags

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

Formats the value using the given formatter.

impl Extend<GameFlags> for GameFlags

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

Extends a collection with the contents of an iterator.

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 GameFlags

const FLAGS: &'static [Flag<GameFlags>] = _

The set of available flags and their names.

type Bits = u8

The underlying storage type.

fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

fn from_bits_retain(bits: u8) -> GameFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

fn empty() -> Self

Returns an empty set of flags.

fn all() -> Self

Returns the set containing all flags.

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

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

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

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

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

Get the flag for a particular name.

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

Iterate over enabled flag values.

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

Iterate over the raw names and bits for enabled flag values.

fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

Returns true if there are flags common to both self and other.

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

Returns true if all of the flags in other are contained within self.

fn insert(&mut self, other: Self)where Self: Sized,

Inserts the specified flags in-place.

fn remove(&mut self, other: Self)where Self: Sized,

Removes the specified flags in-place.

fn toggle(&mut self, other: Self)where Self: Sized,

Toggles the specified flags in-place.

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

Inserts or removes the specified flags depending on the passed value.

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

Returns the intersection between the flags in self and other.

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

Returns the union of between the flags in self and other.

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

Returns the difference between the flags in self and other.

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

Returns the symmetric difference between the flags in self and other.

fn complement(self) -> Self

Returns the complement of this set of flags.

impl FromIterator<GameFlags> for GameFlags

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

Creates a value from an iterator.

impl Hash for GameFlags

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 GameFlags

type Item = GameFlags

The type of the elements being iterated over.

type IntoIter = Iter<GameFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for GameFlags

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

Formats the value using the given formatter.

impl Not for GameFlags

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = GameFlags

The resulting type after applying the ! operator.

impl Octal for GameFlags

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

Formats the value using the given formatter.

impl PartialEq<GameFlags> for GameFlags

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PublicFlags for GameFlags

type Primitive = u8

The type of the underlying storage.

type Internal = InternalBitFlags

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

impl Sub<GameFlags> for GameFlags

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

Returns the set difference of the two sets of flags.

type Output = GameFlags

The resulting type after applying the - operator.

impl SubAssign<GameFlags> for GameFlags

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for GameFlags

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

Formats the value using the given formatter.

impl Copy for GameFlags

impl Eq for GameFlags

impl StructuralEq for GameFlags

impl StructuralPartialEq for GameFlags