Enum ApiKeyKind 

pub enum ApiKeyKind {
    Zone,
    Personal,
}

Which kind of API key a key is, read from its prefix. Core decides by the same prefix, so this is known without a request.

Variants

Zone

dz_…: full access to exactly one zone, no user behind it. Issued by Zones::create_api_key.

Personal

du_…: the access of the user it belongs to. Issued by Users::create_api_key.

Implementations

impl ApiKeyKind

pub fn of(key: &str) -> Option<Self>

The kind of key, or None if it has neither prefix. Core treats such a token as a JWT, so a key without a prefix (e.g. one from before Core issued keys) gets ErrorCode::InvalidToken.

Examples

use dinio_sdk::ApiKeyKind;

assert_eq!(ApiKeyKind::of("dz_abc"), Some(ApiKeyKind::Zone));
assert_eq!(ApiKeyKind::of("du_abc"), Some(ApiKeyKind::Personal));
assert_eq!(ApiKeyKind::of("dinio_abc"), None);

Trait Implementations

impl Clone for ApiKeyKind

fn clone(&self) -> ApiKeyKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ApiKeyKind

impl Debug for ApiKeyKind

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

Formats the value using the given formatter.

impl Display for ApiKeyKind

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

Formats the value using the given formatter.

impl Eq for ApiKeyKind

impl Hash for ApiKeyKind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ApiKeyKind

fn eq(&self, other: &ApiKeyKind) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ApiKeyKind