Struct oxide_api::sleds::Sleds

source · [−]

pub struct Sleds {
    pub client: Client,
}

Fields

client: Client

Implementations

source

impl Sleds

source

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

List sleds in the system.

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

Parameters:

limit: u32 – Maximum number of items returned by a single call.
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.

source

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

List sleds in the system.

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

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

source

pub async fn get(&self, sled_id: &str) -> Result<Sled>

Fetch information about a sled in the system.

This function performs a GET to the /hardware/sleds/{sled_id} endpoint.

Parameters:

sled_id: &str – The sled’s unique ID.

Auto Trait Implementations

impl !RefUnwindSafe for Sleds

impl Send for Sleds

impl Sync for Sleds

impl Unpin for Sleds

impl !UnwindSafe for Sleds

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct oxide_api::sleds::Sleds

Fields

Implementations

impl Sleds

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

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

pub async fn get(&self, sled_id: &str) -> Result<Sled>

Auto Trait Implementations

impl !RefUnwindSafe for Sleds

impl Send for Sleds

impl Sync for Sleds

impl Unpin for Sleds

impl !UnwindSafe for Sleds

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where
T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where
T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where
U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

Struct oxide_api::sleds::Sleds

Fields

Implementations

impl Sleds

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

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

pub async fn get(&self, sled_id: &str) -> Result<Sled>

Auto Trait Implementations

impl !RefUnwindSafe for Sleds

impl Send for Sleds

impl Sync for Sleds

impl Unpin for Sleds

impl !UnwindSafe for Sleds

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,