Trait KeyMap

pub trait KeyMap: Sized {
    type Keys: KeyType;

    const PROPRIETARY_TYPE: Self::Keys;

    // Required methods
    fn retrieve_key_pair<'enc>(
        &'enc self,
        version: PsbtVer,
        key_type: Self::Keys,
    ) -> Vec<KeyPair<Self::Keys, Box<dyn Encode + 'enc>, Box<dyn Encode + 'enc>>>;
    fn insert_singular(
        &mut self,
        key_type: Self::Keys,
        value_data: ValueData,
    ) -> Result<(), PsbtError>;
    fn insert_plural(
        &mut self,
        key_type: Self::Keys,
        key_data: ByteStr,
        value_data: ValueData,
    ) -> Result<(), PsbtError>;

    // Provided methods
    fn encode_map(
        &self,
        version: PsbtVer,
        writer: &mut dyn Write,
    ) -> Result<usize, IoError> { ... }
    fn parse_map(
        &mut self,
        version: PsbtVer,
        map: Map<Self::Keys>,
    ) -> Result<(), PsbtError> { ... }
    fn has_proprietary(&self, key: &PropKey) -> bool { ... }
    fn proprietary(&self, key: &PropKey) -> Option<&ValueData> { ... }
    fn proprietary_mut(&mut self, key: &PropKey) -> Option<&mut ValueData> { ... }
    fn push_proprietary(
        &mut self,
        key: PropKey,
        value: impl Into<ValueData>,
    ) -> Result<(), KeyAlreadyPresent> { ... }
    fn remove_proprietary(&mut self, key: &PropKey) -> Option<ValueData> { ... }
    fn insert_proprietary(&mut self, prop_key: PropKey, value_data: ValueData) { ... }
    fn insert_unknown(
        &mut self,
        key_type: u8,
        key_data: ByteStr,
        value_data: ValueData,
    ) { ... }
}

Required Associated Constants

const PROPRIETARY_TYPE: Self::Keys

Required Associated Types

type Keys: KeyType

Required Methods

fn retrieve_key_pair<'enc>( &'enc self, version: PsbtVer, key_type: Self::Keys, ) -> Vec<KeyPair<Self::Keys, Box<dyn Encode + 'enc>, Box<dyn Encode + 'enc>>>

fn insert_singular( &mut self, key_type: Self::Keys, value_data: ValueData, ) -> Result<(), PsbtError>

fn insert_plural( &mut self, key_type: Self::Keys, key_data: ByteStr, value_data: ValueData, ) -> Result<(), PsbtError>

Provided Methods

fn encode_map( &self, version: PsbtVer, writer: &mut dyn Write, ) -> Result<usize, IoError>

fn parse_map( &mut self, version: PsbtVer, map: Map<Self::Keys>, ) -> Result<(), PsbtError>

fn has_proprietary(&self, key: &PropKey) -> bool

fn proprietary(&self, key: &PropKey) -> Option<&ValueData>

fn proprietary_mut(&mut self, key: &PropKey) -> Option<&mut ValueData>

fn push_proprietary( &mut self, key: PropKey, value: impl Into<ValueData>, ) -> Result<(), KeyAlreadyPresent>

fn remove_proprietary(&mut self, key: &PropKey) -> Option<ValueData>

fn insert_proprietary(&mut self, prop_key: PropKey, value_data: ValueData)

fn insert_unknown( &mut self, key_type: u8, key_data: ByteStr, value_data: ValueData, )

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.

Implementors

impl KeyMap for Input

const PROPRIETARY_TYPE: <Input as KeyMap>::Keys = InputKey::Proprietary

type Keys = InputKey

impl KeyMap for Output

const PROPRIETARY_TYPE: <Output as KeyMap>::Keys = OutputKey::Proprietary

type Keys = OutputKey

impl KeyMap for Psbt

const PROPRIETARY_TYPE: <Psbt as KeyMap>::Keys = GlobalKey::Proprietary

type Keys = GlobalKey