Struct oxide_api::racks::Racks

pub struct Racks {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Racks

pub async fn get_page(
    &self,
    limit: u32,
    page_token: &str,
    sort_by: IdSortMode
) -> Result<Vec<Rack>>

List racks in the system.

This function performs a GET to the /hardware/racks endpoint.

Parameters:

• limit: u32 – A count of bytes, typically used either for memory or storage capacity

The maximum supported byte count is i64::MAX. This makes it somewhat inconvenient to define constructors: a u32 constructor can be infallible, but an i64 constructor can fail (if the value is negative) and a u64 constructor can fail (if the value is larger than i64::MAX). We provide all of these for consumers’ convenience.

• page_token: &str – Token returned by previous call to retreive the subsequent page.
• sort_by: crate::types::IdSortMode – Supported set of sort modes for scanning by id only.

Currently, we only support scanning in ascending order.

pub async fn get_all(&self, sort_by: IdSortMode) -> Result<Vec<Rack>>

List racks in the system.

This function performs a GET to the /hardware/racks endpoint.

As opposed to get, this function returns all the pages of the request at once.

pub async fn get(&self, rack_id: &str) -> Result<Rack>

Fetch information about a particular rack.

This function performs a GET to the /hardware/racks/{rack_id} endpoint.

Parameters:

• rack_id: &str – human-readable free-form text about a resource.