Struct indy::crypto::Key

source ·

pub struct Key {}

Implementations

source

impl Key

source

pub fn create(
wallet_handle: IndyHandle,
my_key_json: Option<&str>
) -> Result<String, ErrorCode>

Creates key pair in wallet

Arguments

wallet_handle - wallet handle (created by Wallet::open)
my_key_json - Optional key information as json. If none then defaults are used.

my_key_json { “seed”: string, (optional) Seed that allows deterministic key creation (if not set random one will be created). Can be UTF-8, base64 or hex string. “crypto_type”: string, // Optional (if not set then ed25519 curve is used); Currently only ‘ed25519’ value is supported for this field. }

Returns

verkey of generated key pair, also used as key identifier

source

pub fn create_timeout(
 wallet_handle: IndyHandle,
 my_key_json: Option<&str>,
 timeout: Duration
) -> Result<String, ErrorCode>

Creates key pair in wallet

Arguments

wallet_handle - wallet handle (created by Wallet::open)
my_key_json - key information as json
timeout - the maximum time this function waits for a response

Example

my_key_json { “seed”: string, (optional) Seed that allows deterministic key creation (if not set random one will be created). Can be UTF-8, base64 or hex string. “crypto_type”: string, // Optional (if not set then ed25519 curve is used); Currently only ‘ed25519’ value is supported for this field. }

Returns

verkey of generated key pair, also used as key identifier

source

pub fn create_async<F: 'static>(
 wallet_handle: IndyHandle,
 my_key_json: Option<&str>,
 closure: F
) -> ErrorCodewhere
 F: FnMut(ErrorCode, String) + Send,

Creates key pair in wallet

Arguments

wallet_handle - wallet handle (created by Wallet::open)
my_key_json - Optional key information as json. If none then defaults are used.
closure - The closure that is called when finished

Example

my_key_json { “seed”: string, (optional) Seed that allows deterministic key creation (if not set random one will be created). Can be UTF-8, base64 or hex string. “crypto_type”: string, // Optional (if not set then ed25519 curve is used); Currently only ‘ed25519’ value is supported for this field. }

Returns

errorcode from calling ffi function. The closure receives the return result

source

pub fn set_metadata(
 wallet_handle: IndyHandle,
 verkey: &str,
 metadata: &str
) -> Result<(), ErrorCode>

Saves/replaces the metadata for the verkey in the wallet

Arguments

wallet_handle - wallet handle (created by Wallet::open)
verkey - the public key or key id where to store the metadata
metadata - the metadata that will be stored with the key, can be empty string

source

pub fn set_metadata_timeout(
 wallet_handle: IndyHandle,
 verkey: &str,
 metadata: &str,
 timeout: Duration
) -> Result<(), ErrorCode>

Saves/replaces the metadata for the verkey in the wallet

Arguments

wallet_handle - wallet handle (created by Wallet::open)
verkey - the public key or key id where to store the metadata
metadata - the metadata that will be stored with the key, can be empty string
timeout - the maximum time this function waits for a response

source

pub fn set_metadata_async<F: 'static>(
 wallet_handle: IndyHandle,
 verkey: &str,
 metadata: &str,
 closure: F
) -> ErrorCodewhere
 F: FnMut(ErrorCode) + Send,

Saves/replaces the metadata for the verkey in the wallet

Arguments

wallet_handle - wallet handle (created by Wallet::open)
verkey - the public key or key id where to store the metadata
metadata - the metadata that will be stored with the key, can be empty string
closure - The closure that is called when finished

source

pub fn get_metadata(
wallet_handle: IndyHandle,
verkey: &str
) -> Result<String, ErrorCode>

Retrieves the metadata for the verkey in the wallet

Argument

wallet_handle - wallet handle (created by Wallet::open)
verkey - the public key or key id to retrieve metadata

Returns

metadata currently stored with the key; Can be empty if no metadata was saved for this key

source

pub fn get_metadata_timeout(
 wallet_handle: IndyHandle,
 verkey: &str,
 timeout: Duration
) -> Result<String, ErrorCode>

Retrieves the metadata for the verkey in the wallet

Argument

wallet_handle - wallet handle (created by Wallet::open)
verkey - the public key or key id to retrieve metadata
timeout - the maximum time this function waits for a response

Returns

metadata currently stored with the key; Can be empty if no metadata was saved for this key

source

pub fn get_metadata_async<F: 'static>(
 wallet_handle: IndyHandle,
 verkey: &str,
 closure: F
) -> ErrorCodewhere
 F: FnMut(ErrorCode, String) + Send,

Retrieves the metadata for the verkey in the wallet

Argument

wallet_handle - wallet handle (created by Wallet::open)
verkey - the public key or key id to retrieve metadata
closure - The closure that is called when finished

Returns

errorcode from calling ffi function

Auto Trait Implementations

impl RefUnwindSafe for Key

impl Send for Key

impl Sync for Key

impl Unpin for Key

impl UnwindSafe for Key

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · 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, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct indy::crypto::Key

Implementations

impl Key

pub fn create( wallet_handle: IndyHandle, my_key_json: Option<&str>) -> Result<String, ErrorCode>

pub fn create_timeout( wallet_handle: IndyHandle, my_key_json: Option<&str>, timeout: Duration) -> Result<String, ErrorCode>

pub fn create_async<F: 'static>( wallet_handle: IndyHandle, my_key_json: Option<&str>, closure: F) -> ErrorCodewhere F: FnMut(ErrorCode, String) + Send,

pub fn set_metadata( wallet_handle: IndyHandle, verkey: &str, metadata: &str) -> Result<(), ErrorCode>

pub fn set_metadata_timeout( wallet_handle: IndyHandle, verkey: &str, metadata: &str, timeout: Duration) -> Result<(), ErrorCode>

pub fn set_metadata_async<F: 'static>( wallet_handle: IndyHandle, verkey: &str, metadata: &str, closure: F) -> ErrorCodewhere F: FnMut(ErrorCode) + Send,

pub fn get_metadata( wallet_handle: IndyHandle, verkey: &str) -> Result<String, ErrorCode>

pub fn get_metadata_timeout( wallet_handle: IndyHandle, verkey: &str, timeout: Duration) -> Result<String, ErrorCode>

pub fn get_metadata_async<F: 'static>( wallet_handle: IndyHandle, verkey: &str, closure: F) -> ErrorCodewhere F: FnMut(ErrorCode, String) + Send,

Auto Trait Implementations

impl RefUnwindSafe for Key

impl Send for Key

impl Sync for Key

impl Unpin for Key

impl UnwindSafe for Key

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn create(
wallet_handle: IndyHandle,
my_key_json: Option<&str>
) -> Result<String, ErrorCode>

pub fn create_timeout(
wallet_handle: IndyHandle,
my_key_json: Option<&str>,
timeout: Duration
) -> Result<String, ErrorCode>

pub fn create_async<F: 'static>(
wallet_handle: IndyHandle,
my_key_json: Option<&str>,
closure: F
) -> ErrorCodewhere
F: FnMut(ErrorCode, String) + Send,

pub fn set_metadata(
wallet_handle: IndyHandle,
verkey: &str,
metadata: &str
) -> Result<(), ErrorCode>

pub fn set_metadata_timeout(
wallet_handle: IndyHandle,
verkey: &str,
metadata: &str,
timeout: Duration
) -> Result<(), ErrorCode>

pub fn set_metadata_async<F: 'static>(
wallet_handle: IndyHandle,
verkey: &str,
metadata: &str,
closure: F
) -> ErrorCodewhere
F: FnMut(ErrorCode) + Send,

pub fn get_metadata(
wallet_handle: IndyHandle,
verkey: &str
) -> Result<String, ErrorCode>

pub fn get_metadata_timeout(
wallet_handle: IndyHandle,
verkey: &str,
timeout: Duration
) -> Result<String, ErrorCode>

pub fn get_metadata_async<F: 'static>(
wallet_handle: IndyHandle,
verkey: &str,
closure: F
) -> ErrorCodewhere
F: FnMut(ErrorCode, String) + Send,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,