Struct KeyHint 

pub struct KeyHint {
    pub pubkey: Option<PublicKey>,
    pub name: Option<String>,
    pub is_global: bool,
}

Key hint for resolving the signer

Contains explicit fields for each hint type. Exactly one hint field should be set. The hint is used to look up the actual public key in AuthSettings for signature verification.

Fields

pubkey: Option<PublicKey>

Public key hint (e.g. Ed25519 verifying key)

name: Option<String>

Name hint: “alice_laptop” - searches keys where name matches

is_global: bool

Whether this hint refers to the global permission

Implementations

impl KeyHint

pub fn from_pubkey(pubkey: &PublicKey) -> Self

Create a hint from a public key

pub fn from_name(name: impl Into<String>) -> Self

Create a hint from a name

pub fn global(actual_pubkey: &PublicKey) -> Self

Create a global permission hint with actual signer pubkey

pub fn is_global(&self) -> bool

Check if this is a global permission hint

pub fn is_set(&self) -> bool

Check if any hint field is set

Returns true if at least one of pubkey, name, or is_global is set.

Unsigned Entry Detection

This method is primarily used to detect unsigned entries during validation. An entry is considered unsigned when:

• The SigKey is Direct with an empty hint (!hint.is_set())
• The signature field is None

This allows databases to operate without authentication when no auth keys are configured, supporting both authenticated and unauthenticated use cases.

// Empty hint - represents an unsigned entry when combined with no signature
let empty = KeyHint::default();
assert!(!empty.is_set());

// Hint with pubkey - this entry requires signature verification
let pubkey = PrivateKey::generate().public_key();
let with_pubkey = KeyHint::from_pubkey(&pubkey);
assert!(with_pubkey.is_set());

// Hint with name only - also requires signature verification
let with_name = KeyHint::from_name("alice_laptop");
assert!(with_name.is_set());

pub fn hint_type(&self) -> &'static str

Get the hint type as a string (for error messages)

Trait Implementations

impl Clone for KeyHint

fn clone(&self) -> KeyHint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyHint

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

Formats the value using the given formatter.

impl Default for KeyHint

fn default() -> KeyHint

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KeyHint

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for KeyHint

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for KeyHint

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for KeyHint

impl StructuralPartialEq for KeyHint