Struct nvml_wrapper::bitmasks::device::ThrottleReasons

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

Flags used to specify why a GPU is throttling.

Implementations

impl ThrottleReasons

pub const GPU_IDLE: Self = _

Nothing is running on the GPU.

This limiter may be removed in a future release.

pub const APPLICATIONS_CLOCKS_SETTING: Self = _

GPU clocks are limited by the current applications clocks setting.

pub const USER_DEFINED_CLOCKS: Self = _

👎Deprecated: Renamed to APPLICATIONS_CLOCKS_SETTING.

pub const SW_POWER_CAP: Self = _

Software power scaling algorithm is reducing clocks.

pub const HW_SLOWDOWN: Self = _

Hardware slowdown (reducing the core clocks by a factor of 2 or more) is engaged.

This is an indicator of:

• Temperature being too high
• External Power Brake Asseration being triggered (e.g. by the system power supply)
• Power draw being too high and Fast Trigger protection reducing the clocks

This may also be reported during powerstate or clock change, behavior that may be removed in a later release.

pub const SYNC_BOOST: Self = _

This GPU is being throttled by another GPU in its sync boost group.

Sync boost groups can be used to maximize performance per watt. All GPUs in a sync boost group will boost to the minimum possible clocks across the entire group. Look at the throttle reasons for other GPUs in the system to find out why this GPU is being held at lower clocks.

pub const SW_THERMAL_SLOWDOWN: Self = _

Software thermal slowdown.

This is an indicator of one or more of the following:

• The current GPU temperature is above the max GPU operating temperature
• The current memory temperature is above the max memory operating temperature

pub const HW_THERMAL_SLOWDOWN: Self = _

Hardware thermal slowdown is engaged, reducing core clocks by 2x or more.

This indicates that the temperature of the GPU is too high.

pub const HW_POWER_BRAKE_SLOWDOWN: Self = _

Hardware power brake slowdown is engaged, reducing core clocks by 2x or more.

This indicates that an external power brake assertion is being triggered, such as by the system power supply.

pub const DISPLAY_CLOCK_SETTING: Self = _

GPU clocks are limited by the current setting of display clocks.

pub const NONE: Self = _

Clocks are as high as possible and are not being throttled.

impl ThrottleReasons

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

Convert from a bits value.

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

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

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u64) -> 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 ThrottleReasons

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

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

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 ThrottleReasons

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

Formats the value using the given formatter.

impl BitAnd for ThrottleReasons

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

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

type Output = ThrottleReasons

The resulting type after applying the & operator.

impl BitAndAssign for ThrottleReasons

fn bitand_assign(&mut self, other: Self)

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

impl BitOr for ThrottleReasons

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

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

type Output = ThrottleReasons

The resulting type after applying the | operator.

impl BitOrAssign for ThrottleReasons

fn bitor_assign(&mut self, other: Self)

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

impl BitXor for ThrottleReasons

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

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

type Output = ThrottleReasons

The resulting type after applying the ^ operator.

impl BitXorAssign for ThrottleReasons

fn bitxor_assign(&mut self, other: Self)

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

impl Clone for ThrottleReasons

fn clone(&self) -> ThrottleReasons

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ThrottleReasons

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

Formats the value using the given formatter.

impl Extend<ThrottleReasons> for ThrottleReasons

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 ThrottleReasons

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

The set of defined flags.

type Bits = u64

The underlying bits type.

fn bits(&self) -> u64

Get the underlying bits value.

fn from_bits_retain(bits: u64) -> ThrottleReasons

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 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 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 FromIterator<ThrottleReasons> for ThrottleReasons

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

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

impl Hash for ThrottleReasons

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 ThrottleReasons

type Item = ThrottleReasons

The type of the elements being iterated over.

type IntoIter = Iter<ThrottleReasons>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for ThrottleReasons

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

Formats the value using the given formatter.

impl Not for ThrottleReasons

fn not(self) -> Self

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

type Output = ThrottleReasons

The resulting type after applying the ! operator.

impl Octal for ThrottleReasons

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

Formats the value using the given formatter.

impl PartialEq for ThrottleReasons

fn eq(&self, other: &ThrottleReasons) -> 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 ThrottleReasons

type Primitive = u64

The type of the underlying storage.

type Internal = InternalBitFlags

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

impl Sub for ThrottleReasons

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

The resulting type after applying the - operator.

impl SubAssign for ThrottleReasons

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 ThrottleReasons

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

Formats the value using the given formatter.

impl Copy for ThrottleReasons

impl Eq for ThrottleReasons

impl StructuralPartialEq for ThrottleReasons