Struct Complete

Source
pub struct Complete {
    pub name: String,
    pub config: Config,
    pub last_modified: DateTime<Utc>,
    pub public_key: PublicKey,
    pub credentials: Option<Credentials>,
}
Expand description

A complete user identity, representing the secret key, public key, and user info

Fields§

§name: String§config: Config§last_modified: DateTime<Utc>§public_key: PublicKey§credentials: Option<Credentials>

Implementations§

Source§

impl Complete

Source

pub async fn prompt_changes( &self, to_replace: Option<String>, link_remote: bool, ) -> Result<Self, Error>

Prompt the user to make changes to an identity, returning the new identity

§Arguments
  • replace_current - The identity to replace
Source

pub async fn create(&self, link_remote: bool) -> Result<(), Error>

Create a complete identity, including writing to disk & exchanging key with origin.

§Arguments
  • link_remote - Override if the identity should be exchanged with the remote.
Source

pub fn replace_with(self, new_identity: Self) -> Result<Self, Error>

Replace an existing identity with a new one.

§Arguments
  • new_identity - The new identity that will be created
Source§

impl Complete

Source

pub fn load(identity_name: &str) -> Result<Self, Error>

Loads a complete identity associated with the given identity name.

§Arguments
  • identity_name - The name of the identity. This is encoded on-disk as identities/<NAME>
Source

pub fn load_all() -> Result<Vec<Self>, Error>

Loads all valid identities found on disk

Source§

impl Complete

Source

pub fn new( name: String, config: Config, public_key: PublicKey, credentials: Option<Credentials>, ) -> Self

Creates a new identity

§Arguments
  • name - The name of the identity. This is encoded on-disk as identities/<NAME>
  • config - User configuration including author details & SSH key
  • public_key - The user’s public key
  • credentials - The user’s secret data including secret key & password
Source

pub fn default() -> Result<Self, Error>

Creates the default identity, inferring details from the user’s profile

Source

pub fn secret_key(&self) -> Option<SecretKey>

Returns the secret key, if one exists

Source

pub fn as_portable(&self) -> Self

Strips the identity of any device-specific information, such as key path & identity name Returns the stripped identity

Source

pub fn decrypt(&self) -> Result<(SKey, Option<String>), Error>

Decrypts the user’s secret key, prompting the user for password if necessary Returns a tuple containing the decrypted key & the valid password

Trait Implementations§

Source§

impl Clone for Complete

Source§

fn clone(&self) -> Complete

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 Debug for Complete

Source§

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

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

impl<'de> Deserialize<'de> for Complete

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 Display for Complete

Source§

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

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

impl Serialize for Complete

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T