Struct SummaryParams 

pub struct SummaryParams { /* private fields */ }

Query parameters for the GET /users/current/summaries endpoint.

Example

use waka_api::SummaryParams;

// Fetch today's summary
let p = SummaryParams::today();

// Fetch the last 7 days, filtered to one project
use chrono::NaiveDate;
let p = SummaryParams::for_range(
    NaiveDate::from_ymd_opt(2025, 1, 6).unwrap(),
    NaiveDate::from_ymd_opt(2025, 1, 12).unwrap(),
)
.project("my-saas");

Implementations

impl SummaryParams

pub fn today() -> Self

Creates params covering only today’s date (local timezone).

pub fn for_range(start: NaiveDate, end: NaiveDate) -> Self

Creates params covering the given inclusive date range.

pub fn project(self, project: &str) -> Self

Filters results to the named project (builder, consumes self).

pub fn branches(self, branches: &str) -> Self

Filters results to the named branches, comma-separated (builder).

pub fn cache_key(&self) -> String

Returns a stable cache key string that uniquely identifies this set of parameters.

Format: summaries:{start}:{end} (with optional :project:{name} suffix).

Example

use waka_api::SummaryParams;
use chrono::NaiveDate;

let p = SummaryParams::for_range(
    NaiveDate::from_ymd_opt(2025, 1, 6).unwrap(),
    NaiveDate::from_ymd_opt(2025, 1, 12).unwrap(),
).project("my-saas");

assert_eq!(p.cache_key(), "summaries:2025-01-06:2025-01-12:project:my-saas");

Trait Implementations

impl Clone for SummaryParams

fn clone(&self) -> SummaryParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SummaryParams

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

Formats the value using the given formatter.