Skip to main content

PowerSchedule

Struct PowerSchedule 

Source
pub struct PowerSchedule {
    pub active_secs: u64,
    pub saver_secs: u64,
    pub critical_secs: u64,
    pub saver_below: f32,
    pub critical_below: f32,
}
Expand description

How often a node samples as its battery drains, in plain seconds.

This is the serializable form of a PowerPlan: a manifest carries the three work intervals as whole seconds and the two state-of-charge thresholds, and plan assembles the pamoja-power governor from them. The thresholds may be omitted from a manifest, in which case they default to entering the saver cadence below 50% charge and the critical cadence below 20%.

Fields§

§active_secs: u64

Seconds between samples at a healthy charge.

§saver_secs: u64

Seconds between samples while conserving.

§critical_secs: u64

Seconds between samples when critically low.

§saver_below: f32

Enter the saver cadence below this state of charge.

§critical_below: f32

Enter the critical cadence below this state of charge.

Implementations§

Source§

impl PowerSchedule

Source

pub fn new(active_secs: u64, saver_secs: u64, critical_secs: u64) -> Self

Creates a schedule from its three work intervals, with default thresholds.

§Arguments
  • active_secs - seconds between samples at a healthy charge.
  • saver_secs - seconds between samples while conserving.
  • critical_secs - seconds between samples when critically low.
§Returns

A schedule that enters the saver cadence below 50% charge and the critical cadence below 20%.

Source

pub fn with_thresholds(self, saver_below: f32, critical_below: f32) -> Self

Sets the state-of-charge thresholds for entering each lower cadence.

§Arguments
  • saver_below - enter the saver cadence when charge is below this.
  • critical_below - enter the critical cadence when charge is below this, normally lower than saver_below.
§Returns

The updated schedule, for chaining.

Source

pub fn plan(&self) -> PowerPlan

Assembles the pamoja-power governor this schedule describes.

§Returns

A PowerPlan with this schedule’s intervals and thresholds.

Trait Implementations§

Source§

impl Clone for PowerSchedule

Source§

fn clone(&self) -> PowerSchedule

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for PowerSchedule

Source§

impl Debug for PowerSchedule

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for PowerSchedule

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for PowerSchedule

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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.
Source§

impl Serialize for PowerSchedule

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for PowerSchedule

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.