Struct ClientModuleConfig

pub struct ClientModuleConfig {
    pub kind: ModuleKind,
    pub version: ModuleConsensusVersion,
    pub config: DynRawFallback<DynClientConfig>,
}

Config for the client-side of a particular Federation module

Since modules are (tbd.) pluggable into Federations, it needs to be some form of an abstract type-erased-like value.

Fields

kind: ModuleKind

version: ModuleConsensusVersion

config: DynRawFallback<DynClientConfig>

Implementations

impl ClientModuleConfig

pub fn from_typed<T: ClientConfig>( module_instance_id: ModuleInstanceId, kind: ModuleKind, version: ModuleConsensusVersion, value: T, ) -> Result<Self>

pub fn redecode_raw( self, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

pub fn is_kind(&self, kind: &ModuleKind) -> bool

pub fn kind(&self) -> &ModuleKind

impl ClientModuleConfig

pub fn cast<T>(&self) -> Result<&T>

where T: 'static,

Trait Implementations

impl Clone for ClientModuleConfig

fn clone(&self) -> ClientModuleConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientModuleConfig

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

Formats the value using the given formatter.

impl Decodable for ClientModuleConfig

fn consensus_decode_from_finite_reader<D: Read>( d: &mut D, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode Self from a size-limited reader.

fn consensus_decode_whole( slice: &[u8], modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

fn consensus_decode<R: Read>( r: &mut R, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode an object with a well-defined format.

fn consensus_decode_hex( hex: &str, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode an object from hex

fn consensus_decode_vec( bytes: Vec<u8>, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

impl<'de> Deserialize<'de> for ClientModuleConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodable for ClientModuleConfig

fn consensus_encode<W: Write>(&self, writer: &mut W) -> Result<usize, Error>

Encode an object with a well-defined format. Returns the number of bytes written on success.

fn consensus_encode_to_vec(&self) -> Vec<u8>

Self::consensus_encode to newly allocated Vec<u8>

fn consensus_encode_to_hex(&self) -> String

Encode and convert to hex string representation

fn consensus_encode_to_len(&self) -> usize

Encode without storing the encoding, return the size

fn consensus_hash<H>(&self) -> H

where H: Hash, H::Engine: Write,

Generate a SHA256 hash of the consensus encoding using the default hash engine for H.

fn consensus_hash_sha256(&self) -> Hash

Self::consensus_hash for [bitcoin::hashes::sha256::Hash]

impl PartialEq for ClientModuleConfig

fn eq(&self, other: &ClientModuleConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ClientModuleConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ClientModuleConfig

impl StructuralPartialEq for ClientModuleConfig