Struct ApiKeyConfig

Source

pub struct ApiKeyConfig {Show 18 fields
    pub config_id: String,
    pub references: ApiKeyReferences,
    pub key_length: usize,
    pub prefix: Option<String>,
    pub default_remaining: Option<i64>,
    pub api_key_header: String,
    pub disable_key_hashing: bool,
    pub starting_characters_length: usize,
    pub store_starting_characters: bool,
    pub max_prefix_length: usize,
    pub min_prefix_length: usize,
    pub max_name_length: usize,
    pub min_name_length: usize,
    pub require_name: bool,
    pub enable_metadata: bool,
    pub key_expiration: KeyExpirationConfig,
    pub rate_limit: RateLimitDefaults,
    pub enable_session_for_api_keys: bool,
}

Expand description

Configuration for the API Key plugin, aligned with the TypeScript ApiKeyOptions.

Fields§

§config_id: String

Name of this configuration, stored on every key it creates. Upstream defaults it to "default".

§references: ApiKeyReferences

Whether keys from this configuration belong to a user or to an organization.

§key_length: usize§prefix: Option<String>§default_remaining: Option<i64>§api_key_header: String§disable_key_hashing: bool§starting_characters_length: usize§store_starting_characters: bool§max_prefix_length: usize§min_prefix_length: usize§max_name_length: usize§min_name_length: usize§require_name: bool§enable_metadata: bool§key_expiration: KeyExpirationConfig§rate_limit: RateLimitDefaults§enable_session_for_api_keys: bool

ApiKeyConfig

Struct ApiKeyConfig Copy item path

Fields§

Trait Implementations§

impl Clone for ApiKeyConfig

fn clone(&self) -> Self

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

impl Debug for ApiKeyConfig

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

impl Default for ApiKeyConfig

fn default() -> Self

Auto Trait Implementations§

impl Freeze for ApiKeyConfig

impl RefUnwindSafe for ApiKeyConfig

impl Send for ApiKeyConfig

impl Sync for ApiKeyConfig

impl Unpin for ApiKeyConfig

impl UnsafeUnpin for ApiKeyConfig

impl UnwindSafe for ApiKeyConfig

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

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

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

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

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

fn borrow(&self) -> &T

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

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

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

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

fn into(self) -> U

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

fn and<P, B, E>(self, other: P) -> And<T, P>where T: Sized + Policy<B, E>, P: Policy<B, E>,

fn or<P, B, E>(self, other: P) -> Or<T, P>where T: Sized + Policy<B, E>, P: Policy<B, E>,

impl<T> Same for T

type Output = T

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = !

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

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

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

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

impl<V, T> VZip<V> for Twhere 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>,

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Struct ApiKeyConfig

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

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

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

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

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

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

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

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>,

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

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

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

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,