Skip to main content

ApiKeyPluginBuilder

Struct ApiKeyPluginBuilder 

Source
pub struct ApiKeyPluginBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<S: State> ApiKeyPluginBuilder<S>

Source

pub fn build(self) -> ApiKeyPlugin
where S: IsComplete,

Finishes building and performs the requested action.

Source

pub fn key_length(self, value: usize) -> ApiKeyPluginBuilder<SetKeyLength<S>>
where S::KeyLength: IsUnset,

Optional (Some / Option setters). Default: 32.

Source

pub fn maybe_key_length( self, value: Option<usize>, ) -> ApiKeyPluginBuilder<SetKeyLength<S>>
where S::KeyLength: IsUnset,

Optional (Some / Option setters). Default: 32.

Source

pub fn prefix(self, value: String) -> ApiKeyPluginBuilder<SetPrefix<S>>
where S::Prefix: IsUnset,

Optional (Some / Option setters).

Source

pub fn maybe_prefix( self, value: Option<String>, ) -> ApiKeyPluginBuilder<SetPrefix<S>>
where S::Prefix: IsUnset,

Optional (Some / Option setters).

Source

pub fn default_remaining( self, value: i64, ) -> ApiKeyPluginBuilder<SetDefaultRemaining<S>>
where S::DefaultRemaining: IsUnset,

Optional (Some / Option setters).

Source

pub fn maybe_default_remaining( self, value: Option<i64>, ) -> ApiKeyPluginBuilder<SetDefaultRemaining<S>>
where S::DefaultRemaining: IsUnset,

Optional (Some / Option setters).

Source

pub fn api_key_header( self, value: String, ) -> ApiKeyPluginBuilder<SetApiKeyHeader<S>>
where S::ApiKeyHeader: IsUnset,

Optional (Some / Option setters). Default: "x-api-key".to_string().

Source

pub fn maybe_api_key_header( self, value: Option<String>, ) -> ApiKeyPluginBuilder<SetApiKeyHeader<S>>
where S::ApiKeyHeader: IsUnset,

Optional (Some / Option setters). Default: "x-api-key".to_string().

Source

pub fn disable_key_hashing( self, value: bool, ) -> ApiKeyPluginBuilder<SetDisableKeyHashing<S>>
where S::DisableKeyHashing: IsUnset,

Optional (Some / Option setters). Default: false.

Source

pub fn maybe_disable_key_hashing( self, value: Option<bool>, ) -> ApiKeyPluginBuilder<SetDisableKeyHashing<S>>
where S::DisableKeyHashing: IsUnset,

Optional (Some / Option setters). Default: false.

Source

pub fn starting_characters_length( self, value: usize, ) -> ApiKeyPluginBuilder<SetStartingCharactersLength<S>>
where S::StartingCharactersLength: IsUnset,

Optional (Some / Option setters). Default: 6.

Source

pub fn maybe_starting_characters_length( self, value: Option<usize>, ) -> ApiKeyPluginBuilder<SetStartingCharactersLength<S>>
where S::StartingCharactersLength: IsUnset,

Optional (Some / Option setters). Default: 6.

Source

pub fn store_starting_characters( self, value: bool, ) -> ApiKeyPluginBuilder<SetStoreStartingCharacters<S>>
where S::StoreStartingCharacters: IsUnset,

Optional (Some / Option setters). Default: true.

Source

pub fn maybe_store_starting_characters( self, value: Option<bool>, ) -> ApiKeyPluginBuilder<SetStoreStartingCharacters<S>>
where S::StoreStartingCharacters: IsUnset,

Optional (Some / Option setters). Default: true.

Source

pub fn max_prefix_length( self, value: usize, ) -> ApiKeyPluginBuilder<SetMaxPrefixLength<S>>
where S::MaxPrefixLength: IsUnset,

Optional (Some / Option setters). Default: 32.

Source

pub fn maybe_max_prefix_length( self, value: Option<usize>, ) -> ApiKeyPluginBuilder<SetMaxPrefixLength<S>>
where S::MaxPrefixLength: IsUnset,

Optional (Some / Option setters). Default: 32.

Source

pub fn min_prefix_length( self, value: usize, ) -> ApiKeyPluginBuilder<SetMinPrefixLength<S>>
where S::MinPrefixLength: IsUnset,

Optional (Some / Option setters). Default: 1.

Source

pub fn maybe_min_prefix_length( self, value: Option<usize>, ) -> ApiKeyPluginBuilder<SetMinPrefixLength<S>>
where S::MinPrefixLength: IsUnset,

Optional (Some / Option setters). Default: 1.

Source

pub fn max_name_length( self, value: usize, ) -> ApiKeyPluginBuilder<SetMaxNameLength<S>>
where S::MaxNameLength: IsUnset,

Optional (Some / Option setters). Default: 32.

Source

pub fn maybe_max_name_length( self, value: Option<usize>, ) -> ApiKeyPluginBuilder<SetMaxNameLength<S>>
where S::MaxNameLength: IsUnset,

Optional (Some / Option setters). Default: 32.

Source

pub fn min_name_length( self, value: usize, ) -> ApiKeyPluginBuilder<SetMinNameLength<S>>
where S::MinNameLength: IsUnset,

Optional (Some / Option setters). Default: 1.

Source

pub fn maybe_min_name_length( self, value: Option<usize>, ) -> ApiKeyPluginBuilder<SetMinNameLength<S>>
where S::MinNameLength: IsUnset,

Optional (Some / Option setters). Default: 1.

Source

pub fn require_name(self, value: bool) -> ApiKeyPluginBuilder<SetRequireName<S>>
where S::RequireName: IsUnset,

Optional (Some / Option setters). Default: false.

Source

pub fn maybe_require_name( self, value: Option<bool>, ) -> ApiKeyPluginBuilder<SetRequireName<S>>
where S::RequireName: IsUnset,

Optional (Some / Option setters). Default: false.

Source

pub fn enable_metadata( self, value: bool, ) -> ApiKeyPluginBuilder<SetEnableMetadata<S>>
where S::EnableMetadata: IsUnset,

Optional (Some / Option setters). Default: false.

Source

pub fn maybe_enable_metadata( self, value: Option<bool>, ) -> ApiKeyPluginBuilder<SetEnableMetadata<S>>
where S::EnableMetadata: IsUnset,

Optional (Some / Option setters). Default: false.

Source

pub fn key_expiration( self, value: KeyExpirationConfig, ) -> ApiKeyPluginBuilder<SetKeyExpiration<S>>
where S::KeyExpiration: IsUnset,

Optional (Some / Option setters). Default: <KeyExpirationConfig as Default>::default().

Source

pub fn maybe_key_expiration( self, value: Option<KeyExpirationConfig>, ) -> ApiKeyPluginBuilder<SetKeyExpiration<S>>
where S::KeyExpiration: IsUnset,

Optional (Some / Option setters). Default: <KeyExpirationConfig as Default>::default().

Source

pub fn rate_limit( self, value: RateLimitDefaults, ) -> ApiKeyPluginBuilder<SetRateLimit<S>>
where S::RateLimit: IsUnset,

Optional (Some / Option setters). Default: <RateLimitDefaults as Default>::default().

Source

pub fn maybe_rate_limit( self, value: Option<RateLimitDefaults>, ) -> ApiKeyPluginBuilder<SetRateLimit<S>>
where S::RateLimit: IsUnset,

Optional (Some / Option setters). Default: <RateLimitDefaults as Default>::default().

Source

pub fn enable_session_for_api_keys( self, value: bool, ) -> ApiKeyPluginBuilder<SetEnableSessionForApiKeys<S>>
where S::EnableSessionForApiKeys: IsUnset,

Optional (Some / Option setters). Default: false.

Source

pub fn maybe_enable_session_for_api_keys( self, value: Option<bool>, ) -> ApiKeyPluginBuilder<SetEnableSessionForApiKeys<S>>
where S::EnableSessionForApiKeys: IsUnset,

Optional (Some / Option setters). Default: false.

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