Skip to main content

UsernameConfig

better_auth_api::plugins::username

Struct UsernameConfig

pub struct UsernameConfig {
    pub min_username_length: f64,
    pub max_username_length: f64,
    pub username_validator: Option<Arc<dyn UsernameValidator>>,
    pub display_username_validator: Option<Arc<dyn UsernameValidator>>,
    pub username_normalization: UsernameNormalization,
    pub display_username_normalization: UsernameNormalization,
    pub username_validation_order: Option<UsernameValidationOrder>,
    pub display_username_validation_order: Option<UsernameValidationOrder>,
    pub immutable_username: bool,
    pub display_username: bool,
    pub username_field_name: Option<String>,
    pub display_username_field_name: Option<String>,
}

Expand description

Username plugin options, independent of the password login plugin.

Fields§

§min_username_length: f64

Minimum UTF-16 length. Zero and NaN select the upstream default of three.

§max_username_length: f64

Maximum UTF-16 length. Zero and NaN select the upstream default of thirty.

§username_validator: Option<Arc<dyn UsernameValidator>>

Custom asynchronous username validator; the default accepts ASCII letters, digits, _ and ..

§display_username_validator: Option<Arc<dyn UsernameValidator>>

Optional asynchronous display-name validator.

§username_normalization: UsernameNormalization

Username normalization; default lowercase is separate from disabled normalization.

§display_username_normalization: UsernameNormalization

Display-name normalization; the default preserves input.

§username_validation_order: Option<UsernameValidationOrder>

Preserve omission because upstream sign-in treats it differently from explicit pre-normalization.

§display_username_validation_order: Option<UsernameValidationOrder>

Display-name validation order.

§immutable_username: bool

Reject changed usernames through the update-user endpoint once a username is set.

§display_username: bool

Add and maintain the separate displayUsername field.

§username_field_name: Option<String>

Serialized application field used to store the username.

§display_username_field_name: Option<String>

Serialized application field used to store the display username.

Trait Implementations§

impl Clone for UsernameConfig

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Default for UsernameConfig

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl !RefUnwindSafe for UsernameConfig

impl !UnwindSafe for UsernameConfig

impl Freeze for UsernameConfig

impl Send for UsernameConfig

impl Sync for UsernameConfig

impl Unpin for UsernameConfig

impl UnsafeUnpin for UsernameConfig

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

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

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

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

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

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

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> PolicyExt for T
where T: ?Sized,

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

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = !

The type returned in the event of a conversion error.

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

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<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

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