Struct ControlOptions 

pub struct ControlOptions {
    pub operating_mode: Option<OperatingMode>,
    pub input_current_limit_ua: Option<u32>,
    pub charge_current_limit_ua: Option<u32>,
    pub float_voltage_uv: Option<u32>,
    pub charge_term_current_ua: Option<u32>,
    pub input_voltage_limit_uv: Option<u32>,
    pub top_off_duration: Option<i64>,
    /* private fields */
}

Operational and electrical constraints applicable to the charger converter.

This is a partial update: only the fields present are applied, and any omitted field leaves the corresponding hardware setting unchanged. While the Controller connection remains open, to relax or withdraw a previously applied limit, set the field again to the desired value, call [Controller.ClearControl] with a mask of fields to withdraw, or close the Controller channel to withdraw all constraints and restore driver defaults.

When a value falls between discrete hardware steps, or when votes from several clients conflict, less charging is preferred. Lower values charge less, except for charge_term_current_ua and input_voltage_limit_uv, where higher values do.

Fields

operating_mode: Option<OperatingMode>

Desired operational mode of the power converter.

input_current_limit_ua: Option<u32>

Input current limit (ICL), in microamps.

charge_current_limit_ua: Option<u32>

Fast charge current (FCC) limit for the battery, in microamps.

float_voltage_uv: Option<u32>

Float (CV) regulation voltage for the battery, in microvolts (bounded by Spec.max_charge_voltage_uv). Note that writing a float voltage target may cause the hardware charge state machine to exit ChargePhase::TOP_OFF and re-evaluate CV regulation.

charge_term_current_ua: Option<u32>

Charge termination (top-off / taper cutoff) current threshold, in microamps: when the charge current falls to it, the charger ends constant-voltage charging.

input_voltage_limit_uv: Option<u32>

Input voltage regulation floor (VINDPM), in microvolts, below which the converter throttles input current draw to prevent source collapse.

top_off_duration: Option<i64>

How long the charger stays in ChargePhase::TOP_OFF, after the charge current falls below the termination threshold, before it enters ChargePhase::DONE.

Trait Implementations

impl Clone for ControlOptions

fn clone(&self) -> ControlOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ControlOptions

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

Formats the value using the given formatter.

impl<D> Decode<ControlOptions, D> for ControlOptions

where D: ResourceDialect,

fn new_empty() -> ControlOptions

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 Default for ControlOptions

fn default() -> ControlOptions

Returns the “default value” for a type.

impl<D> Encode<ControlOptions, D> for &ControlOptions

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 PartialEq for ControlOptions

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

Equality operator ==.

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

Inequality operator !=.

impl Persistable for ControlOptions

impl StructuralPartialEq for ControlOptions

impl TypeMarker for ControlOptions

type Owned = ControlOptions

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 ControlOptions

type Borrowed<'a> = &'a ControlOptions

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: &<ControlOptions as TypeMarker>::Owned, ) -> <ControlOptions as ValueTypeMarker>::Borrowed<'_>

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