Skip to main content

RuntimeEventMask

Struct RuntimeEventMask 

pub struct RuntimeEventMask(/* private fields */);
Expand description

Event types a map or a runtime queues.

Each bit is 1 << RuntimeEventType::raw_value, so a bit derived from a decoded event type matches the constant that names it. A map reads the bits in ALL_MAP_EVENTS and a runtime reads the bits in ALL_RUNTIME_EVENTS, so both accept ALL.

Implementations§

§

impl RuntimeEventMask

pub const NONE: RuntimeEventMask

Selects no event type.

pub const MAP_CAMERA_WILL_CHANGE: RuntimeEventMask

pub const MAP_CAMERA_IS_CHANGING: RuntimeEventMask

pub const MAP_CAMERA_DID_CHANGE: RuntimeEventMask

pub const MAP_CAMERA_TRANSITION_FINISHED: RuntimeEventMask

pub const MAP_STYLE_LOADED: RuntimeEventMask

pub const MAP_LOADING_STARTED: RuntimeEventMask

pub const MAP_LOADING_FINISHED: RuntimeEventMask

pub const MAP_LOADING_FAILED: RuntimeEventMask

pub const MAP_IDLE: RuntimeEventMask

pub const MAP_RENDER_UPDATE_AVAILABLE: RuntimeEventMask

pub const MAP_RENDER_ERROR: RuntimeEventMask

pub const MAP_STILL_IMAGE_FINISHED: RuntimeEventMask

pub const MAP_STILL_IMAGE_FAILED: RuntimeEventMask

pub const MAP_RENDER_FRAME_STARTED: RuntimeEventMask

pub const MAP_RENDER_FRAME_FINISHED: RuntimeEventMask

pub const MAP_RENDER_MAP_STARTED: RuntimeEventMask

pub const MAP_RENDER_MAP_FINISHED: RuntimeEventMask

pub const MAP_STYLE_IMAGE_MISSING: RuntimeEventMask

pub const MAP_TILE_ACTION: RuntimeEventMask

pub const OFFLINE_REGION_STATUS_CHANGED: RuntimeEventMask

pub const OFFLINE_REGION_RESPONSE_ERROR: RuntimeEventMask

pub const OFFLINE_REGION_TILE_COUNT_LIMIT_EXCEEDED: RuntimeEventMask

pub const OFFLINE_OPERATION_COMPLETED: RuntimeEventMask

pub const ALL_MAP_EVENTS: RuntimeEventMask

Selects every map-originated event type this version defines.

pub const ALL_RUNTIME_EVENTS: RuntimeEventMask

Selects every runtime-originated event type this version defines.

pub const ALL: RuntimeEventMask

Selects every event type this version defines.

§

impl RuntimeEventMask

pub const fn empty() -> RuntimeEventMask

Get a flags value with all bits unset.

pub const fn all() -> RuntimeEventMask

Get a flags value with all known bits set.

pub const fn bits(&self) -> u64

Get the underlying bits value.

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

pub const fn from_bits(bits: u64) -> Option<RuntimeEventMask>

Convert from a bits value.

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

pub const fn from_bits_truncate(bits: u64) -> RuntimeEventMask

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u64) -> RuntimeEventMask

Convert from a bits value exactly.

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

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: RuntimeEventMask) -> bool

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

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

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

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

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

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

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: RuntimeEventMask)

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

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

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

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

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

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

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

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

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: RuntimeEventMask, ) -> RuntimeEventMask

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

pub const fn complement(self) -> RuntimeEventMask

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

§

impl RuntimeEventMask

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

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

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 RuntimeEventMask

§

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

Formats the value using the given formatter. Read more
§

impl BitAnd for RuntimeEventMask

§

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

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

§

type Output = RuntimeEventMask

The resulting type after applying the & operator.
§

impl BitAndAssign for RuntimeEventMask

§

fn bitand_assign(&mut self, other: RuntimeEventMask)

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

§

impl BitOr for RuntimeEventMask

§

fn bitor(self, other: RuntimeEventMask) -> RuntimeEventMask

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

§

type Output = RuntimeEventMask

The resulting type after applying the | operator.
§

impl BitOrAssign for RuntimeEventMask

§

fn bitor_assign(&mut self, other: RuntimeEventMask)

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

§

impl BitXor for RuntimeEventMask

§

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

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

§

type Output = RuntimeEventMask

The resulting type after applying the ^ operator.
§

impl BitXorAssign for RuntimeEventMask

§

fn bitxor_assign(&mut self, other: RuntimeEventMask)

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

§

impl Clone for RuntimeEventMask

§

fn clone(&self) -> RuntimeEventMask

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl Debug for RuntimeEventMask

§

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

Formats the value using the given formatter. Read more
§

impl Extend<RuntimeEventMask> for RuntimeEventMask

§

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

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

Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

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. Read more
§

impl Flags for RuntimeEventMask

§

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

The set of defined flags.
§

type Bits = u64

The underlying bits type.
§

fn bits(&self) -> u64

Get the underlying bits value. Read more
§

fn from_bits_retain(bits: u64) -> RuntimeEventMask

Convert from a bits value exactly.
§

fn all_named() -> RuntimeEventMask

Get a flags value with all bits from named flags set. Read more
§

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. Read more
§

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. Read more
§

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

Yield a set of contained flags values. Read more
§

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

Yield a set of contained named flags values. Read more
§

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. Read more
§

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 (&!). Read more
§

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 (&!). Read more
§

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<RuntimeEventMask> for RuntimeEventMask

§

fn from_iter<T>(iterator: T) -> RuntimeEventMask
where T: IntoIterator<Item = RuntimeEventMask>,

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

§

impl Hash for RuntimeEventMask

§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
§

impl IntoIterator for RuntimeEventMask

§

type Item = RuntimeEventMask

The type of the elements being iterated over.
§

type IntoIter = Iter<RuntimeEventMask>

Which kind of iterator are we turning this into?
§

fn into_iter(self) -> <RuntimeEventMask as IntoIterator>::IntoIter

Creates an iterator from a value. Read more
§

impl LowerHex for RuntimeEventMask

§

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

Formats the value using the given formatter. Read more
§

impl Not for RuntimeEventMask

§

fn not(self) -> RuntimeEventMask

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

§

type Output = RuntimeEventMask

The resulting type after applying the ! operator.
§

impl Octal for RuntimeEventMask

§

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

Formats the value using the given formatter. Read more
§

impl PartialEq for RuntimeEventMask

§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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 Sub for RuntimeEventMask

§

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

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

The resulting type after applying the - operator.
§

impl SubAssign for RuntimeEventMask

§

fn sub_assign(&mut self, other: RuntimeEventMask)

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 RuntimeEventMask

§

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

Formats the value using the given formatter. Read more
§

impl Copy for RuntimeEventMask

§

impl Eq for RuntimeEventMask

§

impl StructuralPartialEq for RuntimeEventMask

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.