Skip to main content

io_gmail/v1/rest/labels/
list.rs

1//! List the Gmail labels (`users.labels.list`).
2//!
3//! <https://developers.google.com/gmail/api/reference/rest/v1/users.labels/list>
4
5use alloc::{format, vec::Vec};
6
7use io_http::rfc6750::bearer::HttpAuthBearer;
8use log::{debug, trace};
9use serde::{Deserialize, Serialize};
10use url::Url;
11
12use crate::{
13    coroutine::*,
14    gmail_try,
15    v1::{
16        rest::labels::GmailLabel,
17        send::{GMAIL_API_BASE, GmailSend, GmailSendError, GmailSendOutput},
18    },
19};
20
21/// Response body of `users.labels.list`.
22#[derive(Debug, Clone, Default, Deserialize, Serialize, Eq, PartialEq)]
23#[serde(rename_all = "camelCase")]
24pub struct GmailLabelsListResponse {
25    /// The list of labels.
26    #[serde(default)]
27    pub labels: Vec<GmailLabel>,
28}
29
30/// I/O-free coroutine listing the Gmail labels (`users.labels.list`).
31pub struct GmailLabelsList {
32    send: GmailSend<GmailLabelsListResponse>,
33}
34
35impl GmailLabelsList {
36    /// Builds the `users.labels.list` request for the given user id
37    /// (the mailbox owner, usually `me`).
38    pub fn new(auth: &HttpAuthBearer, user_id: &str) -> Result<Self, GmailSendError> {
39        debug!("prepare gmail labels listing");
40        trace!("user_id: {user_id:?}");
41
42        let url = Url::parse(GMAIL_API_BASE)?.join(&format!("users/{user_id}/labels"))?;
43        let send = GmailSend::get(auth, url);
44
45        Ok(Self { send })
46    }
47}
48
49impl GmailCoroutine for GmailLabelsList {
50    type Yield = GmailYield;
51    type Return = Result<GmailSendOutput<GmailLabelsListResponse>, GmailSendError>;
52
53    fn resume(&mut self, arg: Option<&[u8]>) -> GmailCoroutineState<Self::Yield, Self::Return> {
54        let out = gmail_try!(&mut self.send, arg);
55        debug!("labels listed");
56        trace!("out: {out:?}");
57        GmailCoroutineState::Complete(Ok(out))
58    }
59}