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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
use super::*;
/// Handler for GitHub's releases API.
///
/// Created with [`RepoHandler::release_assets`].
pub struct ReleaseAssetsHandler<'octo, 'r> {
handler: &'r RepoHandler<'octo>,
}
impl<'octo, 'r> ReleaseAssetsHandler<'octo, 'r> {
pub(crate) fn new(parent: &'r RepoHandler<'octo>) -> Self {
Self { handler: parent }
}
/// Gets the release asset using its id.
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// let release = octocrab::instance()
/// .repos("owner", "repo")
/// .release_assets()
/// .get(3)
/// .await?;
/// # Ok(())
/// # }
/// ```
pub async fn get(&self, id: u64) -> Result<models::repos::Asset> {
let route = format!("/{}/releases/assets/{id}", self.handler.repo, id = id,);
self.handler.crab.get(route, None::<&()>).await
}
/// Creates a new [`UpdateReleaseAssetBuilder`] with `asset_id`.
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// # let octocrab = octocrab::Octocrab::default();
/// let release = octocrab.repos("owner", "repo")
/// .release_assets()
/// .update(1)
/// // Optional Parameters
/// .name("asset_1.tar.gz")
/// .label("Asset 1")
/// .state(octocrab::params::repos::release_assets::State::Uploaded)
/// // Send the request
/// .send()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn update(&self, asset_id: u64) -> UpdateReleaseAssetBuilder<'_, '_, '_, '_, '_> {
UpdateReleaseAssetBuilder::new(self, asset_id)
}
/// Delete a release asset using its id.
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// let release = octocrab::instance()
/// .repos("owner", "repo")
/// .release_assets()
/// .delete(3)
/// .await?;
/// # Ok(())
/// # }
/// ```
pub async fn delete(&self, id: u64) -> Result<()> {
let route = format!("/{}/releases/assets/{id}", self.handler.repo, id = id,);
self.handler.crab._delete(route, None::<&()>).await?;
Ok(())
}
/// Streams the binary contents of an asset.
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// use futures_util::StreamExt;
///
/// let mut stream = octocrab::instance()
/// .repos("owner", "repo")
/// .release_assets()
/// .stream(42u64)
/// .await?;
///
/// while let Some(chunk) = stream.next().await {
/// println!("{:?}", chunk);
/// }
/// # Ok(())
/// # }
/// ```
#[cfg(feature = "stream")]
#[cfg_attr(docsrs, doc(cfg(feature = "stream")))]
pub async fn stream(
&self,
id: u64,
) -> crate::Result<impl futures_core::Stream<Item = crate::Result<bytes::Bytes>>> {
use futures_util::TryStreamExt;
//use snafu::GenerateImplicitData;
let route = format!("/{}/releases/assets/{id}", self.handler.repo, id = id,);
let uri = Uri::builder()
.path_and_query(route)
.build()
.context(HttpSnafu)?;
let builder = Builder::new()
.method(http::Method::GET)
.uri(uri)
.header(http::header::ACCEPT, "application/octet-stream");
let request = self.handler.crab.build_request(builder, None::<&()>)?;
let response = self.handler.crab.execute(request).await?;
let response = self.handler.crab.follow_location_to_data(response).await?;
Ok(http_body_util::BodyStream::new(response.into_body())
.try_filter_map(|frame| futures_util::future::ok(frame.into_data().ok())))
}
}
/// A builder pattern struct for updating release assets.
///
/// created by [`ReleaseAssetsHandler::update`].
#[derive(serde::Serialize)]
pub struct UpdateReleaseAssetBuilder<'octo, 'repos, 'handler, 'name, 'label> {
#[serde(skip)]
handler: &'handler ReleaseAssetsHandler<'octo, 'repos>,
#[serde(skip)]
asset_id: u64,
#[serde(skip_serializing_if = "Option::is_none")]
name: Option<&'name str>,
#[serde(skip_serializing_if = "Option::is_none")]
label: Option<&'label str>,
#[serde(skip_serializing_if = "Option::is_none")]
state: Option<crate::params::repos::release_assets::State>,
}
impl<'octo, 'repos, 'handler, 'name, 'label>
UpdateReleaseAssetBuilder<'octo, 'repos, 'handler, 'name, 'label>
{
pub(crate) fn new(
handler: &'handler ReleaseAssetsHandler<'octo, 'repos>,
asset_id: u64,
) -> Self {
Self {
handler,
asset_id,
name: None,
label: None,
state: None,
}
}
/// The name of the release asset.
pub fn name(mut self, name: &'name (impl AsRef<str> + ?Sized)) -> Self {
self.name = Some(name.as_ref());
self
}
/// The label of the release asset.
pub fn label(mut self, label: &'label (impl AsRef<str> + ?Sized)) -> Self {
self.label = Some(label.as_ref());
self
}
/// The state of the release asset.
pub fn state<A: Into<crate::params::repos::release_assets::State>>(
mut self,
state: impl Into<Option<A>>,
) -> Self {
self.state = state.into().map(A::into);
self
}
/// Sends the actual request.
pub async fn send(self) -> crate::Result<crate::models::repos::Asset> {
let route = format!(
"/{repo}/releases/assets/{asset_id}",
repo = self.handler.handler.repo,
asset_id = self.asset_id,
);
self.handler.handler.crab.patch(route, Some(&self)).await
}
}