Struct ClientCredentials

pub struct ClientCredentials<S: ?Sized> { /* private fields */ }

Credentials for the client authentication.

Implementations

impl<S: ?Sized> ClientCredentials<S>

pub fn new( client_id: impl Into<SharedString>, client_secret: impl Into<SharedString>, ) -> Self

Creates a new instance.

pub fn try_from_config(config: &'static Table) -> Result<Self, Error>

Attempts to create a new instance with the configuration.

pub fn set_client_key(&mut self, client_key: impl Into<SharedString>)

Sets the client key.

pub fn set_access_token(&self, access_token: impl ToString)

Sets the access token.

pub fn set_expires(&self, expires_in: Duration)

Sets the expires.

pub fn client_id(&self) -> &str

Returns the client ID.

pub fn client_key(&self) -> &str

Returns the client key.

pub fn client_secret(&self) -> &str

Returns the client secret.

pub fn access_token(&self) -> String

Returns the access token regardless of whether it has expired.

pub fn expires_at(&self) -> DateTime

Returns the time the client credentials expire at.

pub fn expires_in(&self) -> Duration

Returns the time when the client credentials will expire in.

pub fn is_expired(&self) -> bool

Returns true if the access token for the client credentials has expired.

pub fn to_request_params(&self) -> Map

Converts self to the request params.

impl<S: ?Sized + AuthorizationProvider> ClientCredentials<S>

pub async fn request(&self) -> Result<String, Error>

Requests an access token for the client credentials.

Trait Implementations

impl<S: Debug + ?Sized> Debug for ClientCredentials<S>

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

Formats the value using the given formatter.