Enum PowerMode 

pub enum PowerMode {
    Off,
    On,
    Doze,
    DozeSuspend,
    // some variants omitted
}

The power mode of the display hardware.

Variants

Off

Minimize power consumption while keeping the display blank.

Conceptually, the user asked that the display be powered off.

All supporting hardware is in the lowest supported power state, which is ideally “off”.

While in this mode, the display will not generate VSync events.

While in this mode, newly applied display configs will not be reflected on the display. The latest applied config will be reflected on the display once it enters a different power state.

All display devices must support this power mode.

On

Maximize display fidelity, accepting higher power consumption.

Conceptually, the user is fully engaged with the device.

The display may still use power optimizations that do not reduce the user perceived displayed image quality, such as DSC (Display Stream Compression), dynamic refresh rates, or partial refresh.

All display devices must support this power mode.

Doze

Reduce power consumption at the cost of display fidelity.

Conceptually, the user is not fully engaged with the device, but may occasionally glance at the screen.

The display hardware may reduce the displayed image quality in order to save power. The image quality must remain suitable for presenting ambient information to the user.

A display device must support both DOZE and DOZE_SUSPEND power modes, or neither.

DozeSuspend

Reduce power consumption at the cost of display fidelity and freshness.

Conceptually, the user is not fully engaged with the device, but may occasionally glance at the screen. Additionally, the user prefers saving power to seeing an updated display.

In addition to the power savings allowed by the DOZE mode, the display hardware is also free to save power by preserving the old display state, instead of applying new display configs.

The display still emits VSync events to acknowledge newly applied display configs. The latest applied config will be reflected on the display once it enters a different power state.

A display device must support both DOZE and DOZE_SUSPEND power modes, or neither.

Implementations

impl PowerMode

pub fn from_primitive(prim: u32) -> Option<PowerMode>

pub fn from_primitive_allow_unknown(prim: u32) -> PowerMode

pub fn unknown() -> PowerMode

pub const fn into_primitive(self) -> u32

pub fn is_unknown(&self) -> bool

Trait Implementations

impl Clone for PowerMode

fn clone(&self) -> PowerMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PowerMode

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

Formats the value using the given formatter.

impl<D> Decode<PowerMode, D> for PowerMode

where D: ResourceDialect,

fn new_empty() -> PowerMode

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, D>, offset: usize, _depth: Depth, ) -> Result<(), Error>

Decodes an object of type T from the decoder’s buffers into self.

impl<D> Encode<PowerMode, D> for PowerMode

where D: ResourceDialect,

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl Hash for PowerMode

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

where __H: Hasher,

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 Ord for PowerMode

fn cmp(&self, other: &PowerMode) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PowerMode

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

fn partial_cmp(&self, other: &PowerMode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TypeMarker for PowerMode

type Owned = PowerMode

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl ValueTypeMarker for PowerMode

type Borrowed<'a> = PowerMode

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow( value: &<PowerMode as TypeMarker>::Owned, ) -> <PowerMode as ValueTypeMarker>::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Copy for PowerMode

impl Eq for PowerMode

impl StructuralPartialEq for PowerMode