Trait GetKey

pub trait GetKey {
    type Error: Debug;

    // Required method
    fn get_key<C: Signing>(
        &self,
        key_request: KeyRequest,
        secp: &Secp256k1<C>,
    ) -> Result<Option<PrivateKey>, Self::Error>;
}

Trait to get a private key from a key request, key is then used to sign an input.

Required Associated Types

type Error: Debug

An error occurred while getting the key.

Required Methods

fn get_key<C: Signing>( &self, key_request: KeyRequest, secp: &Secp256k1<C>, ) -> Result<Option<PrivateKey>, Self::Error>

Attempts to get the private key for key_request.

Returns

• Some(key) if the key is found.
• None if the key was not found but no error was encountered.
• Err if an error was encountered while looking for the key.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl GetKey for BTreeMap<PublicKey, PrivateKey>

type Error = GetKeyError

fn get_key<C: Signing>( &self, key_request: KeyRequest, _: &Secp256k1<C>, ) -> Result<Option<PrivateKey>, Self::Error>

impl GetKey for BTreeMap<XOnlyPublicKey, PrivateKey>

type Error = GetKeyError

fn get_key<C: Signing>( &self, key_request: KeyRequest, secp: &Secp256k1<C>, ) -> Result<Option<PrivateKey>, Self::Error>

impl GetKey for BTreeSet<Xpriv>

type Error = GetKeyError

fn get_key<C: Signing>( &self, key_request: KeyRequest, secp: &Secp256k1<C>, ) -> Result<Option<PrivateKey>, Self::Error>

impl GetKey for HashMap<PublicKey, PrivateKey>

type Error = GetKeyError

fn get_key<C: Signing>( &self, key_request: KeyRequest, _: &Secp256k1<C>, ) -> Result<Option<PrivateKey>, Self::Error>

impl GetKey for HashMap<XOnlyPublicKey, PrivateKey>

type Error = GetKeyError

fn get_key<C: Signing>( &self, key_request: KeyRequest, secp: &Secp256k1<C>, ) -> Result<Option<PrivateKey>, Self::Error>

impl GetKey for HashSet<Xpriv>

type Error = GetKeyError

fn get_key<C: Signing>( &self, key_request: KeyRequest, secp: &Secp256k1<C>, ) -> Result<Option<PrivateKey>, Self::Error>

Implementors

impl GetKey for Xpriv

type Error = GetKeyError