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 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
use crate::{api::ApiResource, conn::Payload, models, opts, util::url, Result};
use futures_util::stream::Stream;
impl_api_ty!(
Pod => id
);
impl<'podman> Pod<'podman> {
api_doc! {
Pod => StartLibpod
/// Start this pod.
///
/// Parameters:
/// * detach_keys - Override the key sequence for detaching a pod. Format is a single
/// character [a-Z] or ctrl- where is one of: a-z, @, ^, [, , or _.
///
/// Examples:
///
/// ```no_run
/// async {
/// use podman_api::Podman;
/// let podman = Podman::unix("/run/user/1000/podman/podman.sock");
///
/// if let Err(e) = podman.pods().get("79c93f220e3e").start().await {
/// eprintln!("{}", e);
/// }
/// };
/// ```
|
pub async fn start(&self) -> Result<models::PodStartReport> {
self.podman.post_json(&
format!("/libpod/pods/{}/start", &self.id),
Payload::empty()).await
}}
async fn _stop(&self, timeout: Option<usize>) -> Result<models::PodStopReport> {
let ep = url::construct_ep(
&format!("/libpod/pods/{}/stop", &self.id),
timeout.map(|t| url::encoded_pair("t", t.to_string())),
);
self.podman.post_json(&ep, Payload::empty()).await
}
api_doc! {
Pod => StopLibpod
/// Stop this pod.
///
/// Examples:
///
/// ```no_run
/// async {
/// use podman_api::Podman;
/// let podman = Podman::unix("/run/user/1000/podman/podman.sock");
///
/// if let Err(e) = podman.pods().get("79c93f220e3e").stop().await {
/// eprintln!("{}", e);
/// }
/// };
/// ```
|
pub async fn stop(&self) -> Result<models::PodStopReport> {
self._stop(None).await
}}
api_doc! {
Pod => StopLibpod
/// Stop this pod with a timeout.
///
/// Examples:
///
/// ```no_run
/// async {
/// use podman_api::Podman;
/// let podman = Podman::unix("/run/user/1000/podman/podman.sock");
///
/// if let Err(e) = podman.pods().get("79c93f220e3e").stop_with_timeout(10).await {
/// eprintln!("{}", e);
/// }
/// };
/// ```
|
pub async fn stop_with_timeout(&self, t: usize) -> Result<models::PodStopReport> {
self._stop(Some(t)).await
}}
api_doc! {
Pod => InspectLibpod
/// Return low-level information about this pod.
///
/// Examples:
///
/// ```no_run
/// async {
/// use podman_api::Podman;
/// let podman = Podman::unix("/run/user/1000/podman/podman.sock");
///
/// match podman.pods().get("79c93f220e3e").inspect().await {
/// Ok(info) => println!("{:?}", info),
/// Err(e) => eprintln!("{}", e),
/// }
/// };
/// ```
|
pub async fn inspect(&self) -> Result<models::LibpodPodInspectResponse> {
self.podman
.get_json(&format!("/libpod/pods/{}/json", &self.id))
.await
}}
api_doc! {
Pod => KillLibpod
/// Send a signal to this pod.
///
/// Examples:
///
/// ```no_run
/// async {
/// use podman_api::Podman;
/// let podman = Podman::unix("/run/user/1000/podman/podman.sock");
///
/// if let Err(e) = podman.pods().get("79c93f220e3e").send_signal("SIGINT").await {
/// eprintln!("{}", e);
/// }
/// };
/// ```
|
pub async fn send_signal(&self, signal: impl Into<String>) -> Result<models::PodKillReport> {
let ep = url::construct_ep(
&format!("/libpod/pods/{}/kill", &self.id),
Some(url::encoded_pair("signal", signal.into())),
);
self.podman.post_json(&ep, Payload::empty()).await
}}
api_doc! {
Pod => KillLibpod
/// Kill this pod.
///
/// Examples:
///
/// ```no_run
/// async {
/// use podman_api::Podman;
/// let podman = Podman::unix("/run/user/1000/podman/podman.sock");
///
/// if let Err(e) = podman.pods().get("79c93f220e3e").kill().await {
/// eprintln!("{}", e);
/// }
/// };
/// ```
|
pub async fn kill(&self) -> Result<models::PodKillReport> {
self.send_signal("SIGKILL").await
}}
api_doc! {
Pod => PauseLibpod
/// Pause this pod.
///
/// Examples:
///
/// ```no_run
/// async {
/// use podman_api::Podman;
/// let podman = Podman::unix("/run/user/1000/podman/podman.sock");
///
/// if let Err(e) = podman.pods().get("79c93f220e3e").pause().await {
/// eprintln!("{}", e);
/// }
/// };
/// ```
|
pub async fn pause(&self) -> Result<models::PodPauseReport> {
self.podman
.post_json(
&format!("/libpod/pods/{}/pause", &self.id),
Payload::empty(),
)
.await
}}
api_doc! {
Pod => UnpauseLibpod
/// Unpause this pod
///
/// Examples:
///
/// ```no_run
/// async {
/// use podman_api::Podman;
/// let podman = Podman::unix("/run/user/1000/podman/podman.sock");
///
/// if let Err(e) = podman.pods().get("79c93f220e3e").unpause().await {
/// eprintln!("{}", e);
/// }
/// };
/// ```
|
pub async fn unpause(&self) -> Result<models::PodUnpauseReport> {
self.podman
.post_json(
&format!("/libpod/pods/{}/unpause", &self.id),
Payload::empty(),
)
.await
}}
api_doc! {
Pod => RestartLibpod
/// Restart this pod.
///
/// Examples:
///
/// ```no_run
/// async {
/// use podman_api::Podman;
/// let podman = Podman::unix("/run/user/1000/podman/podman.sock");
///
/// if let Err(e) = podman.pods().get("79c93f220e3e").restart().await {
/// eprintln!("{}", e);
/// }
/// };
/// ```
|
pub async fn restart(&self) -> Result<models::PodRestartReport> {
let ep = format!("/libpod/pods/{}/restart", &self.id);
self.podman.post_json(&ep, Payload::empty()).await
}}
async fn _delete(&self, force: bool) -> Result<models::PodRmReport> {
let ep = url::construct_ep(
format!("/libpod/pods/{}", &self.id),
Some(url::encoded_pair("force", force.to_string())),
);
self.podman.delete_json(&ep).await
}
api_doc! {
Pod => DeleteLibpod
/// Delete this pod.
///
/// Examples:
///
/// ```no_run
/// async {
/// use podman_api::Podman;
/// let podman = Podman::unix("/run/user/1000/podman/podman.sock");
///
/// if let Err(e) = podman.pods().get("79c93f220e3e").delete().await {
/// eprintln!("{}", e);
/// }
/// };
/// ```
|
pub async fn delete(&self) -> Result<models::PodRmReport> {
self._delete(false).await
}}
api_doc! {
Pod => DeleteLibpod
/// Force remove this pod.
///
/// Examples:
///
/// ```no_run
/// async {
/// use podman_api::Podman;
/// let podman = Podman::unix("/run/user/1000/podman/podman.sock");
///
/// if let Err(e) = podman.pods().get("79c93f220e3e").remove().await {
/// eprintln!("{}", e);
/// }
/// };
/// ```
|
pub async fn remove(&self) -> Result<models::PodRmReport> {
self._delete(true).await
}}
api_doc! {
Pod => ExistsLibpod
/// Quick way to determine if a pod exists by name or ID.
///
/// Examples:
///
/// ```no_run
/// async {
/// use podman_api::Podman;
/// let podman = Podman::unix("/run/user/1000/podman/podman.sock");
///
/// match podman.pods().get("79c93f220e3e").exists().await {
/// Ok(exists) => if exists {
/// println!("pod exists!");
/// } else {
/// println!("pod doesn't exists!");
/// },
/// Err(e) => eprintln!("check failed: {}", e),
/// }
/// };
/// ```
|
pub async fn exists(&self) -> Result<bool> {
self.podman.resource_exists(ApiResource::Pods, &self.id).await
}}
api_doc! {
Pod => TopLibpod
/// List processes inside this pod.
///
/// Examples:
///
/// ```no_run
/// async {
/// use podman_api::Podman;
/// let podman = Podman::unix("/run/user/1000/podman/podman.sock");
///
/// match podman.pods().get("79c93f220e3e").top(&Default::default()).await {
/// Ok(info) => println!("{:?}", info),
/// Err(e) => eprintln!("{}", e),
/// }
/// };
/// ```
|
pub async fn top(&self, opts: &opts::PodTopOpts) -> Result<models::LibpodPodTopResponse> {
let ep = url::construct_ep(format!("/libpod/pods/{}/top", &self.id), opts.serialize());
self.podman.get_json(&ep).await
}}
api_doc! {
Pod => TopLibpod
/// List processes inside this pod.
///
/// Only supported as of version > 4.0
///
/// Examples:
///
/// ```no_run
/// async {
/// use podman_api::Podman;
/// use futures_util::StreamExt;
/// let podman = Podman::unix("/run/user/1000/podman/podman.sock");
///
/// let mut stream = podman.pods().get("79c93f220e3e").top_stream(&Default::default());
/// while let Some(chunk) = stream.next().await {
/// match chunk{
/// Ok(chunk) => println!("{:?}", chunk),
/// Err(e) => eprintln!("{}", e),
/// }
/// }
/// };
/// ```
|
pub fn top_stream(
&self,
opts: &opts::PodTopOpts,
) -> impl Stream<Item = Result<models::LibpodPodTopResponse>> + Unpin + 'podman {
let ep = url::construct_ep(
format!("/libpod/pods/{}/top", &self.id),
opts.stream().serialize(),
);
Box::pin(self.podman.stream_get_json(ep))
}}
api_doc! {
Generate => SystemdLibpod
/// Generate Systemd Units based on this pod.
///
/// Examples:
///
/// ```no_run
/// async {
/// use podman_api::Podman;
/// let podman = Podman::unix("/run/user/1000/podman/podman.sock");
///
/// match podman
/// .pods()
/// .get("ea03584c0fd6")
/// .generate_systemd_units(&Default::default())
/// .await
/// {
/// Ok(info) => println!("{:?}", info),
/// Err(e) => eprintln!("{}", e),
/// }
/// };
/// ```
|
pub async fn generate_systemd_units(
&self,
opts: &opts::SystemdUnitsOpts,
) -> Result<serde_json::Value> {
self.podman.generate_systemd_units(opts, &self.id).await
}}
}
impl<'podman> Pods<'podman> {
api_doc! {
Pod => ListLibpod
/// Returns a list of pods.
///
/// Examples:
///
/// ```no_run
/// async {
/// use podman_api::Podman;
/// use podman_api::opts::{PodListOpts, PodListFilter};
/// use podman_api::models::PodStatus;
/// let podman = Podman::unix("/run/user/1000/podman/podman.sock");
///
/// for pod in podman
/// .pods()
/// .list(
/// &PodListOpts::builder()
/// .filter([PodListFilter::Status(PodStatus::Degraded)])
/// .build(),
/// )
/// .await
/// .unwrap()
/// {
/// println!("{:?}", pod);
/// }
/// };
/// ```
|
pub async fn list(&self, opts: &opts::PodListOpts) -> Result<Vec<models::ListPodsReport>> {
let ep = url::construct_ep("/libpod/pods/json", opts.serialize());
self.podman.get_json(&ep).await
}}
api_doc! {
Pod => ListLibpod
/// Returns a list of pods.
///
/// Examples:
///
/// ```no_run
/// async {
/// use podman_api::Podman;
/// let podman = Podman::unix("/run/user/1000/podman/podman.sock");
///
/// match podman.pods().prune().await {
/// Ok(info) => println!("{:?}", info),
/// Err(e) => eprintln!("{}", e),
/// }
/// };
/// ```
|
pub async fn prune(&self) -> Result<Vec<models::PodPruneReport>> {
self.podman.get_json("/libpod/pods/prune").await
}}
api_doc! {
Pod => StatsAllLibpod
/// Display a live stream of resource usage statistics for the containers in one or more pods.
///
/// Examples:
///
/// ```no_run
/// async {
/// use podman_api::Podman;
/// use podman_api::opts::PodStatsOpts;
/// use futures_util::StreamExt;
/// let podman = Podman::unix("/run/user/1000/podman/podman.sock");
///
/// let mut stream = podman.pods().stats(&PodStatsOpts::builder().all(true).build());
/// while let Some(chunk) = stream.next().await {
/// match chunk{
/// Ok(chunk) => println!("{:?}", chunk),
/// Err(e) => eprintln!("{}", e),
/// }
/// }
/// };
/// ```
|
pub fn stats(
&self,
opts: &opts::PodStatsOpts,
) -> impl Stream<Item = Result<models::LibpodPodTopResponse>> + Unpin + 'podman {
let ep = url::construct_ep(
"/libpod/pods/stats",
opts.serialize(),
);
Box::pin(self.podman.stream_get_json(ep))
}}
api_doc! {
Pod => CreateLibpod
/// Create a container with specified options.
///
/// Examples:
///
/// ```no_run
/// async {
/// use podman_api::Podman;
/// use podman_api::opts::PodCreateOpts;
/// let podman = Podman::unix("/run/user/1000/podman/podman.sock");
///
/// match podman
/// .pods()
/// .create(&PodCreateOpts::builder().name("my-pod").build())
/// .await
/// {
/// Ok(pod) => { /* do something with the pod */ }
/// Err(e) => eprintln!("{}", e),
/// }
/// };
/// ```
|
pub async fn create(&self, opts: &opts::PodCreateOpts) -> Result<Pod<'_>> {
self.podman
.post_json(
&"/libpod/containers/create",
Payload::Json(opts.serialize()?),
)
.await
.map(|resp: models::IdResponse| Pod::new(self.podman, resp.id))
}}
}