Struct Scopes

pub struct Scopes(<Scopes as PublicFlags>::Internal);

This type represents our knowledge about the set of scope types that a script value can have. In most cases it’s narrowed down to a single scope type, but not always.

The available scope types depend on the game. They are listed in event_scopes.log from the game data dumps.

Tuple Fields

0: <Scopes as PublicFlags>::Internal

Implementations

impl Scopes

pub const None: Self

pub const Value: Self

pub const Bool: Self

pub const Flag: Self

pub const Color: Self

pub const Country: Self

pub const Character: Self

pub const Culture: Self

pub const Province: Self

pub const Pop: Self

pub const Party: Self

pub const Religion: Self

pub const State: Self

pub const War: Self

pub const Accolade: Self

pub const AccoladeType: Self

pub const Activity: Self

pub const ActivityType: Self

pub const Army: Self

pub const Artifact: Self

pub const CasusBelli: Self

pub const CharacterMemory: Self

pub const Combat: Self

pub const CombatSide: Self

pub const CouncilTask: Self

pub const CulturePillar: Self

pub const CultureTradition: Self

pub const Decision: Self

pub const Doctrine: Self

pub const Dynasty: Self

pub const DynastyHouse: Self

pub const Faction: Self

pub const Faith: Self

pub const GovernmentType: Self

pub const GreatHolyWar: Self

pub const HolyOrder: Self

pub const Inspiration: Self

pub const LandedTitle: Self

pub const MercenaryCompany: Self

pub const Scheme: Self

pub const Secret: Self

pub const StoryCycle: Self

pub const Struggle: Self

pub const TitleAndVassalChange: Self

pub const Trait: Self

pub const TravelPlan: Self

pub const VassalContract: Self

pub const VassalObligationLevel: Self

pub const HoldingType: Self

pub const TaxSlot: Self

pub const EpidemicType: Self

pub const Epidemic: Self

pub const LegendType: Self

pub const Legend: Self

pub const GeographicalRegion: Self

pub const Domicile: Self

pub const AgentSlot: Self

pub const TaskContract: Self

pub const TaskContractType: Self

pub const Regiment: Self

pub const CasusBelliType: Self

pub const Battle: Self

pub const BattleSide: Self

pub const Building: Self

pub const BuildingType: Self

pub const CanalType: Self

pub const CivilWar: Self

pub const CulturalCommunity: Self

pub const NewCombatUnit: Self

pub const CommanderOrderType: Self

pub const CountryCreation: Self

pub const CountryDefinition: Self

pub const CountryFormation: Self

pub const Decree: Self

pub const DiplomaticAction: Self

pub const DiplomaticPact: Self

pub const DiplomaticPlay: Self

pub const DiplomaticRelations: Self

pub const Front: Self

pub const Goods: Self

pub const Hq: Self

pub const Ideology: Self

pub const Institution: Self

pub const InstitutionType: Self

pub const InterestMarker: Self

pub const InterestGroup: Self

pub const InterestGroupTrait: Self

pub const InterestGroupType: Self

pub const JournalEntry: Self

pub const Law: Self

pub const LawType: Self

pub const Market: Self

pub const MarketGoods: Self

pub const Objective: Self

pub const PoliticalMovement: Self

pub const PopType: Self

pub const ShippingLane: Self

pub const StateRegion: Self

pub const StateTrait: Self

pub const StrategicRegion: Self

pub const Technology: Self

pub const TechnologyStatus: Self

pub const Theater: Self

pub const TradeRoute: Self

pub const CombatUnitType: Self

pub const MilitaryFormation: Self

pub const Sway: Self

pub const StateGoods: Self

pub const DiplomaticDemand: Self

pub const Company: Self

pub const CompanyType: Self

pub const TravelNode: Self

pub const TravelNodeDefinition: Self

pub const TravelConnection: Self

pub const TravelConnectionDefinition: Self

pub const NavalInvasion: Self

pub const MobilizationOption: Self

pub const PowerBlocPrincipleGroup: Self

pub const DiplomaticPlayType: Self

pub const DiplomaticCatalyst: Self

pub const DiplomaticCatalystType: Self

pub const DiplomaticCatalystCategory: Self

pub const PoliticalLobby: Self

pub const PoliticalLobbyType: Self

pub const PoliticalLobbyAppeasement: Self

pub const PowerBloc: Self

pub const PowerBlocIdentity: Self

pub const PowerBlocPrinciple: Self

pub const HarvestCondition: Self

pub const PoliticalMovementType: Self

pub const HarvestConditionType: Self

pub const Area: Self

pub const CountryCulture: Self

pub const CultureGroup: Self

pub const Deity: Self

pub const Family: Self

pub const Governorship: Self

pub const GreatWork: Self

pub const Job: Self

pub const Legion: Self

pub const LevyTemplate: Self

pub const Region: Self

pub const Siege: Self

pub const SubUnit: Self

pub const Treasure: Self

pub const Unit: Self

impl Scopes

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) -> u128

Get the underlying bits value.

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

pub const fn from_bits(bits: u128) -> 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: u128) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u128) -> 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 this flags value 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 a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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 two flags values.

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 two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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 two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl Scopes

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

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

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 Scopes

pub const fn non_primitive() -> Scopes

pub const fn primitive() -> Scopes

pub const fn all_but_none() -> Scopes

pub fn from_snake_case(s: &str) -> Option<Scopes>

Read a scope type in string form and return it as a Scopes value.

pub fn from_snake_case_multi(s: &str) -> Option<Scopes>

Similar to from_snake_case, but allows multiple scopes separated by | Returns None if any of the conversions fail.

Trait Implementations

impl Binary for Scopes

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

Formats the value using the given formatter.

impl BitAnd for Scopes

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

The bitwise and (&) of the bits in two flags values.

type Output = Scopes

The resulting type after applying the & operator.

impl BitAndAssign for Scopes

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for Scopes

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

The bitwise or (|) of the bits in two flags values.

type Output = Scopes

The resulting type after applying the | operator.

impl BitOrAssign for Scopes

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for Scopes

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

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = Scopes

The resulting type after applying the ^ operator.

impl BitXorAssign for Scopes

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for Scopes

fn clone(&self) -> Scopes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scopes

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

Formats the value using the given formatter.

impl Display for Scopes

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

Formats the value using the given formatter.

impl Extend<Scopes> for Scopes

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 Scopes

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

The set of defined flags.

type Bits = u128

The underlying bits type.

fn bits(&self) -> u128

Get the underlying bits value.

fn from_bits_retain(bits: u128) -> Scopes

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

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 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 a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

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 two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

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 intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl From<Scopes> for FieldScopeContext<'_>

fn from(scopes: Scopes) -> Self

Converts to this type from the input type.

impl FromIterator<Scopes> for Scopes

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

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

impl Hash for Scopes

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 Scopes

type Item = Scopes

The type of the elements being iterated over.

type IntoIter = Iter<Scopes>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for Scopes

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

Formats the value using the given formatter.

impl Not for Scopes

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = Scopes

The resulting type after applying the ! operator.

impl Octal for Scopes

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

Formats the value using the given formatter.

impl PartialEq for Scopes

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PublicFlags for Scopes

type Primitive = u128

The type of the underlying storage.

type Internal = InternalBitFlags

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

impl Sub for Scopes

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

The intersection of a source flags value with the complement of a target flags value (&!).

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 = Scopes

The resulting type after applying the - operator.

impl SubAssign for Scopes

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

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 Scopes

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

Formats the value using the given formatter.

impl Copy for Scopes

impl Eq for Scopes

impl StructuralPartialEq for Scopes