Struct boundary_api::BoundaryClient

pub struct BoundaryClient {
    pub host: Url,
    pub auth_method_id: String,
    pub login_name: String,
    pub password: String,
    // some fields omitted
}

BoundaryClient is used to connect to the Boundary server The Default trait is implemented to cover the Boundary server in dev mode Otherwise you can configure the client prior to authentication using builder pattern methods

Fields

host: Url

auth_method_id: String

login_name: String

password: String

Implementations

impl BoundaryClient

pub fn new<S>(host: S) -> Result<Self, BoundaryError> where
    S: AsRef<str>, 

new() takes in any String or &str that returns Ok() from Url::parse() Need to configure other struct values before running authenticate() against Boundary server

pub fn auth_method_id<'a, S>(&'a mut self, id: S) -> Self where
    S: Into<String>, 

auth_method_id configures the value passed to the Boundary auth method service

pub fn login_name<'a, S>(&'a mut self, login_name: S) -> Self where
    S: Into<String>, 

login_name configures the login name used for connecting to the Boundary auth method service

pub fn password<'a, S>(&'a mut self, password: S) -> Self where
    S: Into<String>, 

password configures the password used for connecting to the Boundary auth method service

pub async fn authenticate<'a>(&'a mut self) -> Result<Response, BoundaryError>

authenticate will connect to the Boundary server using the current struct values

Trait Implementations

impl Clone for BoundaryClient

fn clone(&self) -> BoundaryClient

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BoundaryClient

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

Formats the value using the given formatter.

impl Default for BoundaryClient

fn default() -> Self

These default values correspond to the defaults returned by running Boundary in dev mode