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

pub use self::pr_commit::SpecificPullRequestCommitBuilder;
use crate::models::repos::RepoCommit;
use crate::models::CommentId;
use crate::pulls::specific_pr::pr_comment::SpecificPullRequestCommentBuilder;
use crate::pulls::specific_pr::pr_reviews::ReviewsBuilder;
use crate::pulls::PullRequestHandler;
use crate::Page;

mod pr_comment;
mod pr_commit;
pub(crate) mod pr_reviews;
/// A builder pattern struct for working with a specific pull request data,
/// e.g. reviews, commits, comments, etc.
///
/// created by [`PullRequestHandler::pull_number`]
///
/// [`PullRequestHandler::pull_number`]: ./struct.PullRequestHandler.html#method.pull_number
#[derive(serde::Serialize)]
pub struct SpecificPullRequestBuilder<'octo, 'b> {
    #[serde(skip)]
    handler: &'b PullRequestHandler<'octo>,
    pr_number: u64,
    #[serde(skip_serializing_if = "Option::is_none")]
    per_page: Option<u8>,

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

impl<'octo, 'b> SpecificPullRequestBuilder<'octo, 'b> {
    pub(crate) fn new(handler: &'b PullRequestHandler<'octo>, pr_number: u64) -> Self {
        Self {
            handler,
            pr_number,
            per_page: None,
            page: None,
        }
    }

    /// Results per page (max: 100, default: 30).
    pub fn per_page(mut self, per_page: impl Into<u8>) -> Self {
        self.per_page = Some(per_page.into());
        self
    }

    /// Page number of the results to fetch. (default: 1)
    pub fn page(mut self, page: impl Into<u32>) -> Self {
        self.page = Some(page.into());
        self
    }

    ///Lists a maximum of 250 commits for a pull request.
    /// To receive a complete commit list for pull requests with more than 250 commits,
    /// use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) endpoint.
    pub async fn commits(&self) -> crate::Result<Page<RepoCommit>> {
        let route = format!(
            "/repos/{owner}/{repo}/pulls/{pr_number}/commits",
            owner = self.handler.owner,
            repo = self.handler.repo,
            pr_number = self.pr_number
        );
        self.handler.crab.get(route, Some(&self)).await
    }

    /// Creates a new `ReviewsBuilder`
    /// ```no_run
    /// # use octocrab::models::CommentId;
    ///  async fn run() -> octocrab::Result<()> {
    /// # let octocrab = octocrab::Octocrab::default();
    /// use octocrab::params;
    ///
    /// let _ = octocrab.pulls("owner", "repo")
    ///     .pull_number(42)
    ///     .reviews()
    ///     .review(42)
    ///     .get()
    ///     .await;
    ///     Ok(())
    /// }
    /// ```
    pub fn reviews(&self) -> ReviewsBuilder<'octo, '_> {
        ReviewsBuilder::new(self.handler, self.pr_number)
    }

    /// Creates a new `SpecificPullRequestCommentBuilder`
    /// ```no_run
    /// # use octocrab::models::CommentId;
    ///  async fn run() -> octocrab::Result<()> {
    /// # let octocrab = octocrab::Octocrab::default();
    /// use octocrab::params;
    ///
    /// let _ = octocrab.pulls("owner", "repo")
    ///     .pull_number(42)
    ///     .comment(CommentId(42))
    ///     .reply("new comment")
    ///     .await;
    ///     Ok(())
    ///   }
    /// ```
    pub fn comment(&self, comment_id: CommentId) -> SpecificPullRequestCommentBuilder<'_, '_> {
        SpecificPullRequestCommentBuilder::new(self.handler, self.pr_number, comment_id)
    }
}