Struct fedimint_core::config::ClientConfig

pub struct ClientConfig {
    pub global: GlobalClientConfig,
    pub modules: BTreeMap<ModuleInstanceId, ClientModuleConfig>,
}

Total client config

This includes global settings and client-side module configs.

Fields

global: GlobalClientConfig

modules: BTreeMap<ModuleInstanceId, ClientModuleConfig>

Implementations

impl ClientConfig

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

See DynRawFallback::redecode_raw.

impl ClientConfig

pub fn consensus_hash(&self) -> Hash

Returns the consensus hash for a given client config

pub fn get_module<T: Decodable + 'static>( &self, id: ModuleInstanceId ) -> Result<&T>

pub fn get_module_cfg(&self, id: ModuleInstanceId) -> Result<ClientModuleConfig>

pub fn get_first_module_by_kind<T: Decodable + 'static>( &self, kind: impl Into<ModuleKind> ) -> Result<(ModuleInstanceId, &T)>

(soft-deprecated): Get the first instance of a module of a given kind in defined in config

Since module ids are numerical and for time being we only support 1:1 mint, wallet, ln module code in the client, this is useful, but please write any new code that avoids assumptions about available modules.

pub fn get_first_module_by_kind_cfg( &self, kind: impl Into<ModuleKind> ) -> Result<(ModuleInstanceId, ClientModuleConfig)>

Trait Implementations

impl Clone for ClientConfig

fn clone(&self) -> ClientConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientConfig

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

Formats the value using the given formatter.

impl Decodable for ClientConfig

fn consensus_decode<D: Read>( d: &mut D, 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

impl<'de> Deserialize<'de> for ClientConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodable for ClientConfig

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) -> Result<Vec<u8>, Error>

Self::consensus_encode to newly allocated Vec<u8>

fn consensus_encode_to_hex(&self) -> Result<String, Error>

fn consensus_hash<H>(&self) -> Hwhere H: Hash, H::Engine: Write,

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

impl PartialEq for ClientConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ClientConfig

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 ClientConfig

impl StructuralEq for ClientConfig

impl StructuralPartialEq for ClientConfig