Struct sf_api::sso::SSOAuth

pub struct SSOAuth { /* private fields */ }

Implementations§

impl SSOAuth

pub fn auth_url(&self) -> &Url

Returns the SSO auth url, that the user has to login through

pub async fn try_login(self) -> Result<AuthResponse, SFError>

Tries to login. If the user has successfully authenticated via the auth_url, this will return the normal SFAccount. Otherwise, this will return the existing Auth for you to reattempt the login after a few seconds

pub async fn new(provider: SSOProvider) -> Result<Self, SFError>

Instantiates a new attempt to login through a SSO provider. A user then has to interact with the auth_url this returns to validate the login. Afterwards you can login and transform this into a normal SFAccount

pub async fn new_with_options( provider: SSOProvider, options: ConnectionOptions ) -> Result<Self, SFError>

The same as new(), but with optional connection options

Trait Implementations§

impl Debug for SSOAuth

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for SSOAuth

impl !RefUnwindSafe for SSOAuth

impl Send for SSOAuth

impl Sync for SSOAuth

impl Unpin for SSOAuth

impl !UnwindSafe for SSOAuth

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same for T

type Output = T

Should always be Self

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more