Skip to main content

ClientConfigBuilder

Struct ClientConfigBuilder 

Source
pub struct ClientConfigBuilder { /* private fields */ }
Expand description

Builder for creating ClientConfig instances with fluent API.

Reduces cognitive load when registering OAuth clients with many optional fields. Required fields are set in new(), optional fields via builder methods.

§Example

use auth_framework::client::{ClientConfig, ClientType};
use auth_framework::types::{RedirectUris, Scopes, GrantTypes, ResponseTypes};

let config = ClientConfig::builder("client123", ClientType::Confidential)
    .client_secret("secret456")
    .redirect_uris(RedirectUris::new(vec!["https://example.com/callback".to_string()]))
    .authorized_scopes(Scopes::new(vec!["read".to_string(), "write".to_string()]))
    .client_name("My App")
    .build();

Implementations§

Source§

impl ClientConfigBuilder

Source

pub fn new(client_id: impl Into<String>, client_type: ClientType) -> Self

Create a new builder with required fields.

Sets sensible defaults for optional fields:

  • client_secret: None
  • redirect_uris: empty
  • authorized_scopes: [“read”]
  • authorized_grant_types: [“authorization_code”]
  • authorized_response_types: [“code”]
  • client_name, client_description: None
  • metadata: empty
§Example
use auth_framework::client::{ClientConfigBuilder, ClientType};

let builder = ClientConfigBuilder::new("my-app", ClientType::Public);
let config = builder.build();
assert_eq!(config.client_id, "my-app");
Source

pub fn client_secret(self, client_secret: impl Into<String>) -> Self

Set the client secret.

§Example
use auth_framework::client::{ClientConfigBuilder, ClientType};

let config = ClientConfigBuilder::new("app", ClientType::Confidential)
    .client_secret("s3cret")
    .build();
assert_eq!(config.client_secret.unwrap(), "s3cret");
Source

pub fn redirect_uris(self, redirect_uris: RedirectUris) -> Self

Set the authorized redirect URIs.

§Example
use auth_framework::client::{ClientConfigBuilder, ClientType};
use auth_framework::types::RedirectUris;

let config = ClientConfigBuilder::new("app", ClientType::Public)
    .redirect_uris(RedirectUris::new(vec!["https://example.com/cb".into()]))
    .build();
Source

pub fn authorized_scopes(self, authorized_scopes: Scopes) -> Self

Set the authorized scopes.

§Example
use auth_framework::client::{ClientConfigBuilder, ClientType};
use auth_framework::types::Scopes;

let config = ClientConfigBuilder::new("app", ClientType::Public)
    .authorized_scopes(Scopes::new(vec!["read".into(), "write".into()]))
    .build();
Source

pub fn authorized_grant_types(self, authorized_grant_types: GrantTypes) -> Self

Set the authorized grant types.

§Example
use auth_framework::client::{ClientConfigBuilder, ClientType};
use auth_framework::types::GrantTypes;

let config = ClientConfigBuilder::new("app", ClientType::Confidential)
    .authorized_grant_types(GrantTypes::new(vec!["client_credentials".into()]))
    .build();
Source

pub fn authorized_response_types( self, authorized_response_types: ResponseTypes, ) -> Self

Set the authorized response types.

§Example
use auth_framework::client::{ClientConfigBuilder, ClientType};
use auth_framework::types::ResponseTypes;

let config = ClientConfigBuilder::new("app", ClientType::Public)
    .authorized_response_types(ResponseTypes::new(vec!["code".into()]))
    .build();
Source

pub fn client_name(self, client_name: impl Into<String>) -> Self

Set the client name.

§Example
use auth_framework::client::{ClientConfigBuilder, ClientType};

let config = ClientConfigBuilder::new("app", ClientType::Public)
    .client_name("My Application")
    .build();
assert_eq!(config.client_name.unwrap(), "My Application");
Source

pub fn client_description(self, client_description: impl Into<String>) -> Self

Set the client description.

§Example
use auth_framework::client::{ClientConfigBuilder, ClientType};

let config = ClientConfigBuilder::new("app", ClientType::Public)
    .client_description("OAuth 2.0 demo app")
    .build();
assert_eq!(config.client_description.unwrap(), "OAuth 2.0 demo app");
Source

pub fn metadata(self, metadata: HashMap<String, Value>) -> Self

Set the metadata.

§Example
use auth_framework::client::{ClientConfigBuilder, ClientType};
use std::collections::HashMap;

let mut meta = HashMap::new();
meta.insert("logo_uri".into(), serde_json::json!("https://example.com/logo.png"));
let config = ClientConfigBuilder::new("app", ClientType::Public)
    .metadata(meta)
    .build();
assert!(config.metadata.contains_key("logo_uri"));
Source

pub fn with_metadata(self, key: impl Into<String>, value: Value) -> Self

Add a metadata key-value pair.

§Example
use auth_framework::client::{ClientConfigBuilder, ClientType};

let config = ClientConfigBuilder::new("app", ClientType::Public)
    .with_metadata("tos_uri", serde_json::json!("https://example.com/tos"))
    .build();
assert!(config.metadata.contains_key("tos_uri"));
Source

pub fn build(self) -> ClientConfig

Build the ClientConfig instance.

§Example
use auth_framework::client::{ClientConfigBuilder, ClientType};

let config = ClientConfigBuilder::new("app", ClientType::Public).build();
assert_eq!(config.client_id, "app");

Trait Implementations§

Source§

impl Clone for ClientConfigBuilder

Source§

fn clone(&self) -> ClientConfigBuilder

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 ClientConfigBuilder

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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<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: 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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