Skip to main content

OAuthProviderParams

Struct OAuthProviderParams 

Source
pub struct OAuthProviderParams<'a> {
Show 18 fields pub display_name: &'a str, pub default_issuer: &'a str, pub default_client_id: &'a str, pub default_scopes: &'a str, pub env: OAuthEnvOverrides, pub device_code_path: Option<&'a str>, pub authorize_path: Option<&'a str>, pub token_path: &'a str, pub discover_endpoints: bool, pub device_poll_floor_secs: u64, pub authorize_extras: &'a [(&'a str, &'a str)], pub account_choice_extras: &'a [(&'a str, &'a str)], pub revoke_path: Option<&'a str>, pub callback_path: &'a str, pub loopback_ports: &'a [u16], pub relogin_hint: &'a str, pub session_login_hint: &'a str, pub callback_conflict_hint: &'a str,
}
Expand description

Everything about one provider’s OAuth login that is not logic.

Fields§

§display_name: &'a str

Human name for prompts and errors: “xAI”, “ChatGPT”.

§default_issuer: &'a str§default_client_id: &'a str§default_scopes: &'a str§env: OAuthEnvOverrides§device_code_path: Option<&'a str>

Some device-authorization path under the issuer (xAI); None means the issuer offers no device flow and device login must fail loudly instead of guessing (ChatGPT).

§authorize_path: Option<&'a str>

Some browser authorization path under the issuer (ChatGPT PKCE); None means the issuer offers no browser flow and browser login fails the same loud way (xAI is device-code only).

§token_path: &'a str

Token path under the issuer.

§discover_endpoints: bool

Whether the issuer was discovered (xAI) or pinned (ChatGPT paths).

§device_poll_floor_secs: u64

Seconds the device-code poll runs past the server’s expires_in.

§authorize_extras: &'a [(&'a str, &'a str)]

Extra authorize-endpoint parameters beyond the standard OAuth set, sent verbatim so the issuer sees exactly who is calling.

§account_choice_extras: &'a [(&'a str, &'a str)]

Authorize parameters that ask the issuer to let the user choose the account instead of reusing the browser’s session. Sent unless OAuthEnvOverrides::no_account_prompt_var is set.

§revoke_path: Option<&'a str>

Remote revoke path under the issuer, pinned rather than discovered: revoke must still clear local credentials when the issuer is unreachable, so a discovery fetch would only add a failure mode to a path whose contract is to clean up regardless. None when revocation is purely local (xAI).

§callback_path: &'a str

Registered loopback redirect for browser flows.

§loopback_ports: &'a [u16]

Loopback ports the public client registered, in preference order.

§relogin_hint: &'a str

The command that re-runs this provider’s login, for error guidance.

§session_login_hint: &'a str

The slash command that re-runs this login inside a running session and switches that session’s live client.

§callback_conflict_hint: &'a str

What to tell the user when every callback port is taken.

Implementations§

Source§

impl OAuthProviderParams<'_>

Source

pub fn resolve_inputs(&self) -> ResolvedOAuthInputs

Resolve issuer/client/scopes from the environment, first var wins.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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