Struct UsageData 

pub struct UsageData {
    pub five_hour: UsagePeriod,
    pub seven_day: UsagePeriod,
    pub seven_day_sonnet: Option<UsagePeriod>,
    pub extra_usage: Option<ExtraUsage>,
}

Main usage data returned by get_usage().

Contains utilization data for different time periods.

Fields

five_hour: UsagePeriod

5-hour rolling window usage.

seven_day: UsagePeriod

7-day rolling window usage.

seven_day_sonnet: Option<UsagePeriod>

7-day Sonnet-specific usage (if applicable).

extra_usage: Option<ExtraUsage>

Extra usage billing information (if enabled).

Implementations

impl UsageData

pub fn five_hour_on_pace(&self) -> Option<bool>

Check if 5-hour usage is on pace.

Returns None if reset time is not available. Returns true if current 5-hour utilization is sustainable.

pub fn seven_day_on_pace(&self) -> Option<bool>

Check if 7-day usage is on pace.

Returns None if reset time is not available. Returns true if current 7-day utilization is sustainable.

Trait Implementations

impl Clone for UsageData

fn clone(&self) -> UsageData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UsageData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UsageData

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for UsageData

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UsageData