Struct oxide_api::projects::Projects

source · [−]

pub struct Projects {
    pub client: Client,
}

Fields

client: Client

Implementations

source

impl Projects

source

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

List all projects.

This function performs a GET to the /organizations/{organization_name}/projects 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::NameOrIdSortMode – Supported set of sort modes for scanning by name or id.
organization_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’.

source

pub async fn get_all(
 &self,
 organization_name: &str,
 sort_by: NameOrIdSortMode
) -> Result<Vec<Project>>

List all projects.

This function performs a GET to the /organizations/{organization_name}/projects endpoint.

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

source

pub async fn post(
 &self,
 organization_name: &str,
 body: &ProjectCreate
) -> Result<Project>

Create a new project.

This function performs a POST to the /organizations/{organization_name}/projects endpoint.

Parameters:

organization_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’.

source

pub async fn get(
 &self,
 organization_name: &str,
 project_name: &str
) -> Result<Project>

Fetch a specific project.

This function performs a GET to the /organizations/{organization_name}/projects/{project_name} endpoint.

Parameters:

organization_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’.
project_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’.

source

pub async fn put(
 &self,
 organization_name: &str,
 project_name: &str,
 body: &ProjectUpdate
) -> Result<Project>

Update a specific project.

This function performs a PUT to the /organizations/{organization_name}/projects/{project_name} endpoint.

Parameters:

organization_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’.
project_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’.

source

pub async fn delete(
 &self,
 organization_name: &str,
 project_name: &str
) -> Result<()>

Delete a specific project.

This function performs a DELETE to the /organizations/{organization_name}/projects/{project_name} endpoint.

Parameters:

organization_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’.
project_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’.

Auto Trait Implementations

impl !RefUnwindSafe for Projects

impl Send for Projects

impl Sync for Projects

impl Unpin for Projects

impl !UnwindSafe for Projects

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::projects::Projects

Fields

Implementations

impl Projects

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

pub async fn get_all( &self, organization_name: &str, sort_by: NameOrIdSortMode) -> Result<Vec<Project>>

pub async fn post( &self, organization_name: &str, body: &ProjectCreate) -> Result<Project>

pub async fn get( &self, organization_name: &str, project_name: &str) -> Result<Project>

pub async fn put( &self, organization_name: &str, project_name: &str, body: &ProjectUpdate) -> Result<Project>

pub async fn delete( &self, organization_name: &str, project_name: &str) -> Result<()>

Auto Trait Implementations

impl !RefUnwindSafe for Projects

impl Send for Projects

impl Sync for Projects

impl Unpin for Projects

impl !UnwindSafe for Projects

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,
organization_name: &str,
page_token: &str,
sort_by: NameOrIdSortMode
) -> Result<Vec<Project>>

pub async fn get_all(
&self,
organization_name: &str,
sort_by: NameOrIdSortMode
) -> Result<Vec<Project>>

pub async fn post(
&self,
organization_name: &str,
body: &ProjectCreate
) -> Result<Project>

pub async fn get(
&self,
organization_name: &str,
project_name: &str
) -> Result<Project>

pub async fn put(
&self,
organization_name: &str,
project_name: &str,
body: &ProjectUpdate
) -> Result<Project>

pub async fn delete(
&self,
organization_name: &str,
project_name: &str
) -> Result<()>

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>,