Struct oxide_api::users::Users

pub struct Users {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Users

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

This function performs a GET to the /users endpoint. * List the built-in system users * 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 – human-readable free-form text about a resource.
• sort_by: crate::types::NameSortModeAscending – Supported set of sort modes for scanning by name only

Currently, we only support scanning in ascending order.

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

This function performs a GET to the /users endpoint. * As opposed to get, this function returns all the pages of the request at once. * List the built-in system users

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

This function performs a GET to the /users/{user_name} endpoint. * Fetch a specific built-in system user * Parameters: *

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