oxide 0.16.0+2026032500.0.0

SDK for the Oxide rack
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

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.

// Copyright 2025 Oxide Computer Company

//! The `extra` feature adds additional, non-generated, compound interfaces to
//! the [`Client`](crate::Client).
//!
//! It is intended for methods that are functional rather than for those that
//! offer enhanced output or a simplified interface.
//!
//! These interfaces operate very similarly to the generated interfaces.

// Note: This is why the the CLI uses a disk import interface from here, but
// has a number of custom network subcommands that pretty-print or provide a
// simpler user interface for common use cases.

pub mod disk;

/// Higher level operations beyond the generated operations from
/// [`ClientDisksExt`](crate::ClientDisksExt)
pub trait ClientExtraDiskExt {
    /// A convenience wrapper around the SDK to simplify disk creation.
    /// Create a disk, optionally with a snapshot and image. The standard
    /// disk import methods in the SDK will frequently leave the partially
    /// imported disks when interrupted or an error occurs. This extension
    /// will attempt to cleanup the disk.
    ///
    /// Arguments:
    /// - `project`: Name or ID of the project
    /// - `description`: Human-readable free-form text about the disk
    /// - `upload_task_ct`: The number of tokio tasks used to upload the disk
    /// - `disk`: Name of the disk
    /// - `disk_info`: Information needed to construct the disk
    /// - `image_info`: Information needed to construct a snapshot and image, optional
    ///
    /// The [`execute`](disk::builder::DiskImport::execute) method is equivalent to the
    /// `send` method used in standard SDK actions.
    /// ```ignore
    /// client.disk_import()
    ///    .project(project)
    ///    .description(description)
    ///    .upload_task_ct(upload_task_ct)
    ///    .disk(disk)
    ///    .disk_info(disk_info)
    ///    .image_info(image_info)
    ///    .execute()?.await?;
    /// ```
    ///
    /// The [`execute_with_control`](disk::builder::DiskImport::execute_with_control)
    /// method returns a future for the import and a [`DiskImportHandle`](disk::types::DiskImportHandle).
    /// The handle exposes a [`progress`](disk::types::DiskImportHandle::progress) method
    /// to check the current number of bytes uploaded, and a
    /// [`cancel`](disk::types::DiskImportHandle::cancel) method that will stop the
    /// import and remove the new disk.
    /// ```ignore
    /// let (import_future, handle) = client.disk_import()
    ///    .project(project)
    ///    .description(description)
    ///    .upload_task_ct(upload_task_ct)
    ///    .disk(disk)
    ///    .disk_info(disk_info)
    ///    .image_info(image_info)
    ///    .execute_with_control()?;
    ///
    /// let pb = ProgressBar::new();
    /// let progress_rx = handler.progress();
    /// tokio::spawn(async move {
    ///     loop {
    ///         _ = tokio::signal::ctrl_c() => {
    ///            handle.cancel();
    ///         }
    ///         _ = progress_rx.changed() => {
    ///             pb.set_position(*progress_rs.borrow());
    ///         }
    ///     }
    /// });
    ///
    /// import_future.await?;
    /// ```
    fn disk_import(&self) -> disk::builder::DiskImport<'_>;
}