Struct AuthKey 

pub struct AuthKey {
    pub name: Option<String>,
    /* private fields */
}

Authentication key configuration stored in _settings.auth

Keys are indexed by pubkey in AuthSettings. The name field is optional metadata that can be used as a hint in signatures.

Fields

name: Option<String>

Optional human-readable name for this key Multiple keys can share the same name (aliases)

Implementations

impl AuthKey

pub fn new( name: Option<&str>, permissions: Permission, status: KeyStatus, ) -> Self

Create a new AuthKey with validation

Arguments

• name - Optional human-readable name for this key
• permissions - Permission level for this key
• status - Current status of the key

Examples

use eidetica::auth::types::{AuthKey, Permission, KeyStatus};

let key = AuthKey::new(
    Some("alice_laptop"),
    Permission::Write(10),
    KeyStatus::Active
);

pub fn active(name: Option<&str>, permissions: Permission) -> Self

Create a new active AuthKey (common case)

Arguments

• name - Optional human-readable name for this key
• permissions - Permission level for this key

Examples

use eidetica::auth::types::{AuthKey, Permission};

let key = AuthKey::active(
    Some("alice_laptop"),
    Permission::Admin(1)
);

pub fn name(&self) -> Option<&str>

Get the optional name

pub fn permissions(&self) -> &Permission

Get the permissions

pub fn status(&self) -> &KeyStatus

Get the status

pub fn set_status(&mut self, status: KeyStatus)

Set the status (e.g., for revocation)

pub fn set_permissions(&mut self, permissions: Permission)

Set the permissions (e.g., for updates)

pub fn set_name(&mut self, name: Option<&str>)

Set the name

Trait Implementations

impl Clone for AuthKey

fn clone(&self) -> AuthKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<AuthKey> for Doc

fn from(key: AuthKey) -> Doc

Converts to this type from the input type.

impl From<AuthKey> for Value

fn from(key: AuthKey) -> Value

Converts to this type from the input type.

impl Serialize for AuthKey

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Doc> for AuthKey

type Error = Error

The type returned in the event of a conversion error.

fn try_from(doc: &Doc) -> Result<Self>

Performs the conversion.