Skip to main content

Keyring

Struct Keyring 

Source
pub struct Keyring {
    pub keys: Vec<KeyEntry>,
}
Expand description

The on-disk registry (keys.json).

Fields§

§keys: Vec<KeyEntry>

Implementations§

Source§

impl Keyring

Source

pub fn load_default() -> Result<Keyring, KeyringError>

Load from the default config path. A missing file yields an empty registry (reading records nothing).

Source

pub fn load_from(path: &Path) -> Result<Keyring, KeyringError>

Load from a specific path. A missing file yields an empty registry.

Source

pub fn save_default(&self) -> Result<PathBuf, KeyringError>

Persist to the default config path, creating parent dirs. Opt-in: only call this from an explicit user action. Returns the path written.

Source

pub fn save_to(&self, path: &Path) -> Result<(), KeyringError>

Persist to a specific path, creating parent dirs. Opt-in.

Source

pub fn add(&mut self, entry: KeyEntry) -> Result<(), KeyringError>

Add a new entry. Rejects duplicate names and duplicate serials.

Source

pub fn remove(&mut self, name: &str) -> bool

Remove the entry with name. Returns true if one was removed.

Source

pub fn by_name(&self, name: &str) -> Option<&KeyEntry>

Source

pub fn by_serial(&self, serial: &str) -> Option<&KeyEntry>

Source

pub fn name_for(&self, serial: Option<&str>) -> Option<&str>

The friendly name for a connected device’s serial, if one is registered. Used by list to annotate devices.

Source

pub fn resolve<'a>( &self, name: &str, connected: &'a [ConnectedKey], ) -> Result<&'a ConnectedKey, ResolveError>

Resolve a --name to a connected device by matching serials.

Trait Implementations§

Source§

impl Clone for Keyring

Source§

fn clone(&self) -> Keyring

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Keyring

Source§

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

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

impl Default for Keyring

Source§

fn default() -> Keyring

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Keyring

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Keyring

Source§

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

Serialize this value into the given Serde serializer. Read more

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> 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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.