Struct ClientCredentials 

pub struct ClientCredentials {
    pub client_id: String,
    pub client_secret: ClientSecret,
}

A pair of Client ID and Client Secret, used to request an OAuth Client Credentials Grant

Fields

client_id: String

The client ID

client_secret: ClientSecret

The client secret.

Implementations

impl ClientCredentials

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

Construct a new ClientCredentials

pub fn client_id(&self) -> &str

Get the client ID.

pub const fn client_secret(&self) -> &ClientSecret

Get the client secret.

pub async fn request_access_token( &self, auth_server: &AuthServer, ) -> Result<SecretAccessToken, TokenError>

Request and return an access token from the given auth server using this set of client credentials.

Errors

See TokenError

impl ClientCredentials

pub fn __repr__(&self) -> String

Implements __repr__ for Python in terms of the Rust Debug implementation.

Trait Implementations

impl Clone for ClientCredentials

fn clone(&self) -> ClientCredentials

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientCredentials

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClientCredentials

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ClientCredentials> for OAuthGrant

fn from(v: ClientCredentials) -> Self

Converts to this type from the input type.

impl<'py> IntoPyObject<'py> for ClientCredentials

type Target = ClientCredentials

The Python output type

type Output = Bound<'py, <ClientCredentials as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PartialEq for ClientCredentials

fn eq(&self, other: &ClientCredentials) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PyClass for ClientCredentials

type Frozen = True

Whether the pyclass is frozen.

impl PyClassImpl for ClientCredentials

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// A pair of Client ID and Client Secret, used to request an OAuth Client Credentials Grant

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<ClientCredentials>

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForClientCredentials

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::ImmutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for ClientCredentials

const TEXT_SIGNATURE: &'static str = "(client_id, client_secret)"

impl PyTypeInfo for ClientCredentials

const NAME: &'static str = "ClientCredentials"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for ClientCredentials

impl Eq for ClientCredentials

impl ExtractPyClassWithClone for ClientCredentials

impl StructuralPartialEq for ClientCredentials