Enum CostPeriod 

pub enum CostPeriod {
    Day,
    Month,
}

Calendar period, in UTC, over which the cost of a role is counted.

Examples

use std::str::FromStr;
use ironflow_core::agent_role::CostPeriod;

assert_eq!(CostPeriod::from_str("day").ok(), Some(CostPeriod::Day));
assert_eq!(CostPeriod::Month.to_string(), "month");

Variants

Day

From midnight UTC to the next midnight UTC.

Month

From the 1st of the month at 00:00 UTC to the 1st of the next month.

Implementations

impl CostPeriod

pub fn as_str(self) -> &'static str

Stable name of the period, as stored and sent over the API.

Examples

use ironflow_core::agent_role::CostPeriod;

assert_eq!(CostPeriod::Day.as_str(), "day");

pub fn start(self, now: DateTime<Utc>) -> DateTime<Utc>

Start of the period containing now.

Examples

use chrono::{TimeZone, Utc};
use ironflow_core::agent_role::CostPeriod;

let now = Utc.with_ymd_and_hms(2026, 7, 26, 15, 30, 0).unwrap();
assert_eq!(CostPeriod::Day.start(now), Utc.with_ymd_and_hms(2026, 7, 26, 0, 0, 0).unwrap());

Panics

Never panics for a valid DateTime<Utc>: midnight of an existing day is always unambiguous in UTC.

pub fn next_start(self, now: DateTime<Utc>) -> DateTime<Utc>

Start of the period following the one containing now: when the counter resets.

Examples

use chrono::{TimeZone, Utc};
use ironflow_core::agent_role::CostPeriod;

let now = Utc.with_ymd_and_hms(2026, 12, 26, 15, 30, 0).unwrap();
assert_eq!(
    CostPeriod::Month.next_start(now),
    Utc.with_ymd_and_hms(2027, 1, 1, 0, 0, 0).unwrap()
);

Panics

Panics only past the last date chrono represents (year 262143).

Trait Implementations

impl Clone for CostPeriod

fn clone(&self) -> CostPeriod

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CostPeriod

impl Debug for CostPeriod

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CostPeriod

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CostPeriod

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

Formats the value using the given formatter.

impl Eq for CostPeriod

impl FromStr for CostPeriod

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<CostPeriod, <CostPeriod as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for CostPeriod

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

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CostPeriod

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CostPeriod

impl TryFrom<&str> for CostPeriod

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<CostPeriod, <CostPeriod as TryFrom<&str>>::Error>

Performs the conversion.