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
//! The gitignore API
use crate::error::HttpSnafu;
use http::{request, Uri};
use snafu::ResultExt;
use crate::Octocrab;
/// Handler for GitHub's gitignore API.
///
/// Created with [`Octocrab::gitignore`].
pub struct GitignoreHandler<'octo> {
crab: &'octo Octocrab,
}
impl<'octo> GitignoreHandler<'octo> {
pub(crate) fn new(crab: &'octo Octocrab) -> Self {
Self { crab }
}
/// List all templates available to pass as an option when creating a
/// repository.
///
/// See: [GitHub API Documentation](https://docs.github.com/rest/gitignore/gitignore#get-all-gitignore-templates)
///
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// let list = octocrab::instance().gitignore().list().await?;
/// # Ok(())
/// # }
/// ```
pub async fn list(&self) -> crate::Result<Vec<String>> {
self.crab.get("/gitignore/templates", None::<&()>).await
}
/// Get the source of a single template.
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// let gitignore = octocrab::instance().gitignore().get("C").await?;
/// # Ok(())
/// # }
/// ```
pub async fn get(&self, name: impl AsRef<str>) -> crate::Result<String> {
let route = format!("/gitignore/templates/{name}", name = name.as_ref());
let uri = Uri::builder()
.path_and_query(route)
.build()
.context(HttpSnafu)?;
let mut request = request::Builder::new().method("GET").uri(uri);
request = request.header(http::header::ACCEPT, crate::format_media_type("raw"));
let request = self.crab.build_request(request, None::<&()>)?;
let response = self.crab.execute(request).await?;
self.crab.body_to_string(response).await
}
}