Struct seaplane_cli::api::FormationsReq

pub struct FormationsReq { /* private fields */ }

Wraps an SDK FormationsRequest where we do additional things like re-use request access tokens, allow changing the Formation this request is pointed to, and map errors appropriately.

Implementations

impl FormationsReq

pub fn new<S: AsRef<str>>(ctx: &Ctx, oid: Option<S>) -> Result<Self>

Builds a FormationsRequest and immediately requests an access token using the given API key.

If the oid is None it should be noted that not all requests can be made without error. At present only is FormationsRequest::create and FormationsRequest::get_all_formations

pub fn new_delay_token(ctx: &Ctx) -> Result<Self>

Builds a FormationsRequest but does not request an access token using the given API key.

You must call refresh_token to have the access token requested.

pub fn refresh_token(&mut self) -> Result<()>

Request a new Access Token

pub fn token_or_refresh(&mut self) -> Result<&str>

Retrieves the JWT access token, requesting a new one if required.

pub fn set_id_str<S: AsRef<str>>(&mut self, oid: S) -> Result<()>

Sets the Formation ID and re-builds the inner FormationsRequest also requesting a new access token if required

pub fn set_id(&mut self, oid: FormationId) -> Result<()>

Sets the Formation ID and re-builds the inner FormationsRequest also requesting a new access token if required

impl FormationsReq

pub fn create( &mut self, formation: &FormationModel ) -> Result<CreateFormationResponse>

pub fn delete(&mut self) -> Result<DeleteFormationResponse>

pub fn get(&mut self) -> Result<GetFormationResponse>

pub fn get_all(&mut self) -> Result<GetFormationsResponse>

Trait Implementations

impl Debug for FormationsReq

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.