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
//! The markdown API
use snafu::ResultExt;
use crate::Octocrab;
/// Handler for GitHub's markdown API.
///
/// Created with [`Octocrab::markdown`].
pub struct MarkdownHandler<'octo> {
crab: &'octo Octocrab,
}
impl<'octo> MarkdownHandler<'octo> {
pub(crate) fn new(crab: &'octo Octocrab) -> Self {
Self { crab }
}
/// Render an arbitrary Markdown document.
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// use octocrab::params;
///
/// let markdown = octocrab::instance()
/// .markdown()
/// .render("Comment referencing issue #404")
/// .mode(params::markdown::Mode::Gfm)
/// .context("owner/repo")
/// .send()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn render<'r, 'text>(
&'r self,
text: &'text (impl AsRef<str> + ?Sized),
) -> RenderMarkdownBuilder<'octo, 'r, 'text> {
RenderMarkdownBuilder::new(self, text.as_ref())
}
/// Render a Markdown document in raw mode.
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// use octocrab::params;
///
/// let markdown = octocrab::instance()
/// .markdown()
/// .render_raw("~~_**Octocrab**_~~")
/// .await?;
/// # Ok(())
/// # }
/// ```
pub async fn render_raw(&self, text: impl Into<String>) -> crate::Result<String> {
let request = self
.crab
.client
.post(self.crab.absolute_url("markdown/raw")?)
.header(reqwest::header::CONTENT_TYPE, "text/x-markdown")
.body(text.into());
self.crab
.execute(request)
.await?
.text()
.await
.context(crate::error::Http)
}
}
#[derive(serde::Serialize)]
pub struct RenderMarkdownBuilder<'octo, 'r, 'text> {
#[serde(skip)]
handler: &'r MarkdownHandler<'octo>,
text: &'text str,
#[serde(skip_serializing_if = "Option::is_none")]
mode: Option<crate::params::markdown::Mode>,
#[serde(skip_serializing_if = "Option::is_none")]
context: Option<String>,
}
impl<'octo, 'r, 'text> RenderMarkdownBuilder<'octo, 'r, 'text> {
pub(crate) fn new(handler: &'r MarkdownHandler<'octo>, text: &'text str) -> Self {
Self {
handler,
text,
mode: None,
context: None,
}
}
/// The repository context to use when creating references in `Mode::Gfm`.
/// Omit this parameter when using markdown mode.
pub fn context<A: Into<String>>(mut self, context: impl Into<Option<A>>) -> Self {
self.context = context.into().map(A::into);
self
}
/// The rendering mode.
pub fn mode(mut self, mode: impl Into<Option<crate::params::markdown::Mode>>) -> Self {
self.mode = mode.into();
self
}
/// Send the actual request.
pub async fn send(self) -> crate::Result<String> {
self.handler
.crab
._post(self.handler.crab.absolute_url("markdown")?, Some(&self))
.await?
.text()
.await
.context(crate::error::Http)
}
}
#[cfg(test)]
mod tests {
#[test]
fn serialize() {
let octocrab = crate::instance();
let handler = octocrab.markdown();
let render = handler
.render("**Markdown**")
.mode(crate::params::markdown::Mode::Gfm)
.context("owner/repo");
assert_eq!(
serde_json::to_value(render).unwrap(),
serde_json::json!({
"text": "**Markdown**",
"mode": "gfm",
"context": "owner/repo",
})
)
}
}