Struct JsonWithKind

pub struct JsonWithKind {
    kind: ModuleKind,
    value: Value,
}

serde_json::Value that must contain kind: String field

TODO: enforce at ser/deserialization TODO: make inside prive and enforce kind on construction, to other functions non-falliable

Fields

kind: ModuleKind

value: Value

Implementations

impl JsonWithKind

pub fn new(kind: ModuleKind, value: Value) -> JsonWithKind

pub fn with_fixed_empty_value(self) -> JsonWithKind

Workaround for a serde flatten quirk

We serialize config with no fields as: eg. { kind: "ln" }.

When kind gets removed and value is parsed, it will parse as Value::Object that is empty.

However empty module structs, like struct FooConfigLocal; (unit struct), will fail to deserialize with this value, as they expect Value::Null.

We can turn manually empty object into null, and that’s what we do in this function. This fixes the deserialization into unit type, but in turn breaks deserialization into struct Foo{}, which is arguably much less common, but valid.

TODO: In the future, we should have a typed and erased versions of module construction traits, and then we can try with and without the workaround to have both cases working. See https://github.com/fedimint/fedimint/issues/1303

pub fn value(&self) -> &Value

pub fn kind(&self) -> &ModuleKind

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

Trait Implementations

impl Clone for JsonWithKind

fn clone(&self) -> JsonWithKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JsonWithKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JsonWithKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for JsonWithKind

fn eq(&self, other: &JsonWithKind) -> 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 JsonWithKind

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for JsonWithKind

impl StructuralPartialEq for JsonWithKind