Skip to main content

Credentials

Enum Credentials 

Source
pub enum Credentials {
    None,
    ApiKey {
        key: String,
    },
    AccessKey {
        access_key: String,
        secret_key: String,
        session_token: Option<String>,
    },
    OAuth2 {
        access_token: String,
        refresh_token: Option<String>,
        expires_at: Option<DateTime<Utc>>,
    },
    ServiceAccount {
        key_json: String,
        project_id: Option<String>,
    },
    SasToken {
        token: String,
        expires_at: Option<DateTime<Utc>>,
    },
    IamRole {
        role_arn: String,
        session_name: String,
    },
    Custom {
        data: HashMap<String, String>,
    },
}
Expand description

Authentication credentials

Variants§

§

None

No authentication

§

ApiKey

API key authentication

Fields

§key: String

API key

§

AccessKey

Access key and secret key (AWS-style)

Fields

§access_key: String

Access key ID

§secret_key: String

Secret access key

§session_token: Option<String>

Optional session token

§

OAuth2

OAuth 2.0 token

Fields

§access_token: String

Access token

§refresh_token: Option<String>

Optional refresh token

§expires_at: Option<DateTime<Utc>>

Token expiration time

§

ServiceAccount

Service account key (GCP-style JSON)

Fields

§key_json: String

Service account key JSON

§project_id: Option<String>

Project ID

§

SasToken

Shared Access Signature token (Azure-style)

Fields

§token: String

SAS token

§expires_at: Option<DateTime<Utc>>

Token expiration time

§

IamRole

IAM role credentials

Fields

§role_arn: String

Role ARN

§session_name: String

Session name

§

Custom

Custom credentials with arbitrary key-value pairs

Fields

§data: HashMap<String, String>

Credential data

Implementations§

Source§

impl Credentials

Source

pub fn api_key(key: impl Into<String>) -> Self

Creates API key credentials

Source

pub fn access_key( access_key: impl Into<String>, secret_key: impl Into<String>, ) -> Self

Creates access key credentials

Source

pub fn access_key_with_session( access_key: impl Into<String>, secret_key: impl Into<String>, session_token: impl Into<String>, ) -> Self

Creates access key credentials with session token

Source

pub fn oauth2(access_token: impl Into<String>) -> Self

Creates OAuth 2.0 credentials

Source

pub fn oauth2_with_refresh( access_token: impl Into<String>, refresh_token: impl Into<String>, ) -> Self

Creates OAuth 2.0 credentials with refresh token

Source

pub fn service_account_from_json(json: impl Into<String>) -> Result<Self>

Creates service account credentials from JSON

Source

pub fn service_account_from_file(path: impl AsRef<Path>) -> Result<Self>

Creates service account credentials from file

Source

pub fn sas_token(token: impl Into<String>) -> Self

Creates SAS token credentials

Source

pub fn iam_role( role_arn: impl Into<String>, session_name: impl Into<String>, ) -> Self

Creates IAM role credentials

Source

pub fn is_expired(&self) -> bool

Checks if credentials are expired

Source

pub fn needs_refresh(&self) -> bool

Returns true if credentials need refresh

Trait Implementations§

Source§

impl Clone for Credentials

Source§

fn clone(&self) -> Credentials

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Credentials

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

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<U> for T
where U: From<T>,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::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