hey-sdk 0.31.0

Rust client for the HEY API, generated from a Smithy model of the API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

//! The calendars index as a live follower needs it, and the selection every period read is
//! scoped to.

use serde::{Deserialize, Serialize};

use crate::error::Error;
use crate::generated::routes;
use crate::generated::types::Calendar;

pub use crate::generated::services::calendars::*;

/// A calendar as the index serves it, wrapped with what a live follower needs.
///
/// `recording_changes_url` is where the calendar's own recording changes feed starts; read
/// it with [`crate::services::CalendarChangesCursor::from_url`]. `signed_stream_name`
/// subscribes the calendar's stream over Action Cable — a frame arriving there means the
/// calendar changed, and the name is stable for the calendar's life. The calendar changes
/// feed's added bucket carries this same shape, so a calendar learned of either way arrives
/// subscribable.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct ListedCalendar {
    /// The calendar itself, as [`Calendars::list`] serves it.
    #[serde(default)]
    pub calendar: Calendar,
    /// Where the calendar's recording changes feed starts.
    #[serde(default)]
    pub recording_changes_url: Option<String>,
    /// The Action Cable stream that announces the calendar's changes.
    #[serde(default)]
    pub signed_stream_name: Option<String>,
}

/// The full calendars index: every calendar with its changes URL and signed stream name,
/// the calendar-level changes feed's own URL, and the calendars the reader has switched on.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct CalendarList {
    /// Every calendar the identity sees, each with what a live follower needs.
    #[serde(default)]
    pub calendars: Vec<ListedCalendar>,
    /// Where the calendar-level changes feed starts.
    #[serde(default)]
    pub calendar_changes_url: Option<String>,
    /// The calendars the reader has switched on, which every period read is scoped to.
    #[serde(default)]
    pub selected_calendar_ids: Vec<i64>,
}

impl Calendars<'_> {
    /// Lists the calendars with everything [`Calendars::list`] throws away: each calendar's
    /// recording changes URL and signed stream name, and the calendar changes URL. It is
    /// the same read, decoded into the fuller shape the wire already carries.
    pub async fn list_with_changes(&self) -> Result<CalendarList, Error> {
        let operation = self.client().operation(&routes::LIST_CALENDARS, &[]);
        self.client().send(operation).await
    }

    /// Switches a calendar in or out of the reader's selection and answers the ids the
    /// selection is left holding. Every
    /// [`CalendarPeriods`](crate::services::calendar_periods::CalendarPeriods) read is scoped
    /// to that selection, so this is how a client changes which calendars a day, week or
    /// year is drawn from.
    pub async fn toggle_selection(&self, calendar_id: i64) -> Result<Vec<i64>, Error> {
        Ok(self.toggle(calendar_id).await?.selected_calendar_ids)
    }
}