Struct AuthOptions

Source
pub struct AuthOptions<'a> { /* private fields */ }
Expand description

Authentication options Only the API key is mandatory. By default a uuid is not validated, the random split characters are %., and max age or tolerance is 5 minutes (or 300000 milliseconds) NB: The random split characters (rand_char_str) may not include alphanumeric characters or underscores, as these would break other validation

Implementations§

Source§

impl<'a> AuthOptions<'a>

Source

pub fn new(api_key: &'a str) -> Self

Source

pub fn set_rand_char_str(&mut self, char_str: &'a str) -> Self

Source

pub fn key(&self) -> &'a str

Return the shared API key, for internal use in your app only

Source

pub fn rand_chars(&self) -> Vec<char>

Return the random split characters as an array

Source

pub fn tolerance(&self) -> i64

Timestamp tolerance in milliseconds

Source

pub fn should_check_uuid(&self) -> bool

Only validate embedded UUIDs if this flag is true

Source

pub fn check_uuid(&mut self, val: bool) -> Self

Set check UUID status. True means it must be present in a valid hexadecimal format once decoded

Source

pub fn set_tolerance(&mut self, millis: u32) -> Self

Set timestamp tolerance in milliseconds

Source

pub fn set_tolerance_secs(&mut self, secs: u32) -> Self

Set timestamp tolerance in seconds

Source

pub fn set_tolerance_mins(&mut self, mins: u32) -> Self

Set timestamp tolerance in minutes

Trait Implementations§

Source§

impl<'a> Clone for AuthOptions<'a>

Source§

fn clone(&self) -> AuthOptions<'a>

Returns a copy 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<'a> Debug for AuthOptions<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Copy for AuthOptions<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for AuthOptions<'a>

§

impl<'a> RefUnwindSafe for AuthOptions<'a>

§

impl<'a> Send for AuthOptions<'a>

§

impl<'a> Sync for AuthOptions<'a>

§

impl<'a> Unpin for AuthOptions<'a>

§

impl<'a> UnwindSafe for AuthOptions<'a>

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