octocrab 0.51.0

A modern, extensible GitHub API client.
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

//! Github Starring API

use http::header::HeaderMap;
use http::header::ACCEPT;
use serde::Serialize;

use crate::models::activity::StarredRepository;
use crate::Octocrab;
use crate::Page;
use crate::Result;

/// Handler for GitHub's starring API.
///
/// Created with [`ActivityHandler::starring`].
///
/// [`ActivityHandler::starring`]: ../struct.ActivityHandler.html#method.starring
pub struct StarringHandler<'octo> {
    crab: &'octo Octocrab,
}

impl<'octo> StarringHandler<'octo> {
    pub(crate) fn new(crab: &'octo Octocrab) -> Self {
        Self { crab }
    }

    /// Lists repositories a user has starred.
    ///
    /// ```no_run
    /// # async fn run() -> octocrab::Result<()> {
    /// octocrab::instance()
    ///     .activity()
    ///     .starring()
    ///     .list_repos_starred_by_user("some_user")
    ///     .send()
    ///     .await?;
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// [See the GitHub API documentation](https://docs.github.com/en/rest/activity/starring?apiVersion=2022-11-28#list-repositories-starred-by-a-user)
    pub fn list_repos_starred_by_user(
        &self,
        username: impl Into<String>,
    ) -> ListReposStarredByUserBuilder<'_> {
        ListReposStarredByUserBuilder::new(self.crab, username)
    }
}

/// A builder pattern struct for listing starred by user repositories.
///
/// Created by [`StarringHandler::list_repos_starred_by_user`].
///
/// [`StarringHandler::list_repos_starred_by_user`]: ./struct.StarringHandler.html#method.list_repos_starred_by_user
#[derive(Serialize)]
pub struct ListReposStarredByUserBuilder<'octo> {
    #[serde(skip)]
    crab: &'octo Octocrab,

    #[serde(skip_serializing_if = "Option::is_none")]
    direction: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    page: Option<u8>,

    #[serde(skip_serializing_if = "Option::is_none")]
    per_page: Option<u8>,

    #[serde(skip_serializing_if = "Option::is_none")]
    sort: Option<String>,

    #[serde(skip)]
    username: String,
}

impl<'octo> ListReposStarredByUserBuilder<'octo> {
    pub fn new(crab: &'octo Octocrab, username: impl Into<String>) -> Self {
        Self {
            crab,
            direction: None,
            page: None,
            per_page: None,
            sort: None,
            username: username.into(),
        }
    }

    /// The direction to sort the results by.
    ///
    /// [See the GitHub API documentation](https://docs.github.com/en/rest/activity/starring?apiVersion=2022-11-28#list-repositories-starred-by-a-user--parameters)
    pub fn direction(mut self, direction: impl Into<String>) -> Self {
        self.direction = Some(direction.into());
        self
    }

    /// The page number of the results to fetch.
    ///
    /// [See the GitHub API documentation](https://docs.github.com/en/rest/activity/starring?apiVersion=2022-11-28#list-repositories-starred-by-a-user--parameters)
    pub fn page(mut self, page: impl Into<u8>) -> Self {
        self.page = Some(page.into());
        self
    }

    /// The number of results per page (max `100`).
    ///
    /// [See the GitHub API documentation](https://docs.github.com/en/rest/activity/starring?apiVersion=2022-11-28#list-repositories-starred-by-a-user--parameters)
    pub fn per_page(mut self, per_page: impl Into<u8>) -> Self {
        self.per_page = Some(per_page.into());
        self
    }

    pub async fn send(self) -> Result<Page<StarredRepository>> {
        let mut headers = HeaderMap::new();

        headers.insert(
            ACCEPT,
            "application/vnd.github.star+json"
                .parse()
                .expect("valid header value"),
        );

        self.crab
            .get_with_headers(
                format!("/users/{username}/starred", username = self.username),
                None::<&()>,
                Some(headers),
            )
            .await
    }

    /// The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.
    ///
    /// [See the GitHub API documentation](https://docs.github.com/en/rest/activity/starring?apiVersion=2022-11-28#list-repositories-starred-by-a-user--parameters)
    pub fn sort(mut self, sort: impl Into<String>) -> Self {
        self.sort = Some(sort.into());
        self
    }
}