Trait Decodable 

pub trait Decodable: Sized {
    // Provided methods
    fn consensus_decode_partial_from_finite_reader<R: Read>(
        r: &mut R,
        modules: &ModuleDecoderRegistry,
    ) -> Result<Self, DecodeError> { ... }
    fn consensus_decode_whole(
        slice: &[u8],
        modules: &ModuleDecoderRegistry,
    ) -> Result<Self, DecodeError> { ... }
    fn consensus_decode_partial<R: Read>(
        r: &mut R,
        modules: &ModuleDecoderRegistry,
    ) -> Result<Self, DecodeError> { ... }
    fn consensus_decode_hex(
        hex: &str,
        modules: &ModuleDecoderRegistry,
    ) -> Result<Self, DecodeError> { ... }
}

Data which can be encoded in a consensus-consistent way

Provided Methods

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

Decode Self from a size-limited reader.

Like consensus_decode_partial but relies on the reader being limited in the amount of data it returns, e.g. by being wrapped in std::io::Take.

Failing to abide to this requirement might lead to memory exhaustion caused by malicious inputs.

Users should default to consensus_decode_partial, but when data to be decoded is already in a byte vector of a limited size, calling this function directly might be marginally faster (due to avoiding extra checks).

Rules for trait implementations

• Simple types that that have a fixed size (own and member fields), don’t have to overwrite this method, or be concern with it, should only impl consensus_decode_partial.
• Types that deserialize based on decoded untrusted length should implement consensus_decode_partial_from_finite_reader only:
  • Default implementation of consensus_decode_partial will forward to consensus_decode_partial_from_finite_reader with the reader wrapped by Take, protecting from readers that keep returning data.
  • Implementation must make sure to put a cap on things like Vec::with_capacity and other allocations to avoid oversized allocations, and rely on the reader being finite and running out of data, and collections reallocating on a legitimately oversized input data, instead of trying to enforce arbitrary length limits.
• Types that contain other types that might be require limited reader (thus implementing consensus_decode_partial_from_finite_reader), should also implement it applying same rules, and in addition make sure to call consensus_decode_partial_from_finite_reader on all members, to avoid creating redundant Take wrappers (Take<Take<...>>). Failure to do so might result only in a tiny performance hit.

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

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

Decode an object with a well-defined format.

This is the method that should be implemented for a typical, fixed sized type implementing this trait. Default implementation is wrapping the reader in std::io::Take to limit the input size to MAX_DECODE_SIZE, and forwards the call to Self::consensus_decode_partial_from_finite_reader, which is convenient for types that override Self::consensus_decode_partial_from_finite_reader instead.

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

Decode an object from hex

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 Decodable for Cow<'static, str>

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

impl Decodable for bool

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

impl Decodable for u8

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

impl Decodable for u16

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

impl Decodable for u32

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

impl Decodable for u64

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

impl Decodable for ()

fn consensus_decode_partial<D: Read>( _d: &mut D, _modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

impl Decodable for String

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

impl Decodable for Address<NetworkUnchecked>

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

impl Decodable for Amount

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

impl Decodable for BigSize

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

impl Decodable for BlockHash

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

impl Decodable for Bolt11Invoice

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

impl Decodable for Ciphertext

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

impl Decodable for DecryptionShare

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

impl Decodable for G1Affine

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

impl Decodable for G1Projective

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

impl Decodable for G2Affine

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

impl Decodable for G2Projective

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

impl Decodable for Hash

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

impl Decodable for Hash

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

impl Decodable for Header

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

impl Decodable for Keypair

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

impl Decodable for Network

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

impl Decodable for OutPoint

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

impl Decodable for PartialMerkleTree

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

impl Decodable for Psbt

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

impl Decodable for PublicKey

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

impl Decodable for PublicKey

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

impl Decodable for PublicKey

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

impl Decodable for PublicKeySet

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

impl Decodable for RoutingFees

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

impl Decodable for Scalar

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

impl Decodable for ScriptBuf

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

impl Decodable for SecretKey

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

impl Decodable for SecretKey

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

impl Decodable for Signature

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

impl Decodable for Signature

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

impl Decodable for Transaction

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

impl Decodable for TxOut

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

impl Decodable for Txid

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

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

impl Decodable for XOnlyPublicKey

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

impl<K> Decodable for BTreeSet<K>

where K: Decodable + Ord,

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

impl<K> Decodable for Descriptor<K>

where Self: FromStr, <Self as FromStr>::Err: ToString + Error + Send + Sync + 'static, K: MiniscriptKey,

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

impl<K, V> Decodable for BTreeMap<K, V>

where K: Decodable + Ord, V: Decodable,

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

impl<T1: Decodable, T2: Decodable> Decodable for (T1, T2)

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

impl<T1: Decodable, T2: Decodable, T3: Decodable> Decodable for (T1, T2, T3)

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

impl<T1: Decodable, T2: Decodable, T3: Decodable, T4: Decodable> Decodable for (T1, T2, T3, T4)

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

impl<T1: Decodable, T2: Decodable, T3: Decodable, T4: Decodable, T5: Decodable> Decodable for (T1, T2, T3, T4, T5)

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

impl<T1: Decodable, T2: Decodable, T3: Decodable, T4: Decodable, T5: Decodable, T6: Decodable> Decodable for (T1, T2, T3, T4, T5, T6)

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

impl<T> Decodable for Option<T>

where T: Decodable,

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

impl<T> Decodable for Box<T>

where T: Decodable,

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

impl<T> Decodable for VecDeque<T>

where T: Decodable + 'static,

Uses the same zero-sized element policy as Vec<T>: empty deques are supported, but nonempty deques of zero-sized types return a decode error.

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

impl<T> Decodable for Vec<T>

where T: Decodable + 'static,

Empty vectors are supported for all element types. Nonempty vectors of zero-sized types return a decode error without invoking the element decoder. A finite reader alone cannot bound iteration over elements that consume no bytes.

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

impl<T, E> Decodable for Result<T, E>

where T: Decodable, E: Decodable,

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

impl<T, const SIZE: usize> Decodable for [T; SIZE]

where T: Decodable + Debug + Default + Copy + 'static,

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

Implementors

impl Decodable for ServerStatusLegacy

impl Decodable for DkgMessageG1

impl Decodable for DkgMessageG2

impl Decodable for P2PMessage

impl Decodable for InviteCodePart

impl Decodable for ConsensusItem

impl Decodable for SessionStatus

impl Decodable for SessionStatusV2

impl Decodable for PeerEndpoints

impl Decodable for TransactionError

impl Decodable for TransactionSignature

impl Decodable for ClientBackupKey

impl Decodable for ClientBackupKeyPrefix

impl Decodable for ClientBackupSnapshot

impl Decodable for ClientConfig

impl Decodable for ClientConfigV0

impl Decodable for ClientModuleConfig

impl Decodable for FederationId

impl Decodable for FederationIdPrefix

impl Decodable for GlobalClientConfig

impl Decodable for GlobalClientConfigV0

impl Decodable for PeerUrl

impl Decodable for ServerModuleConsensusConfig

impl Decodable for BackupRequest

impl Decodable for DynClientConfig

impl Decodable for DynInput

impl Decodable for DynInputError

impl Decodable for DynModuleConsensusItem

impl Decodable for DynOutput

impl Decodable for DynOutputError

impl Decodable for DynOutputOutcome

impl Decodable for ModuleKind

impl Decodable for OperationId

impl Decodable for DatabaseVersion

impl Decodable for DatabaseVersionKey

impl Decodable for DatabaseVersionKeyV0

impl Decodable for AltDbPrefixTestPrefix

impl Decodable for AltTestKey

impl Decodable for DbPrefixTestPrefix

impl Decodable for DbPrefixTestPrefixV0

impl Decodable for PercentPrefixTestPrefix

impl Decodable for PercentTestKey

impl Decodable for TestKey

impl Decodable for TestKeyV0

impl Decodable for TestVal

impl Decodable for BitcoinRpcConfig

impl Decodable for InviteCode

impl Decodable for AmountUnit

impl Decodable for Amounts

impl Decodable for ApiVersion

impl Decodable for CoreConsensusVersion

impl Decodable for ModuleConsensusVersion

impl Decodable for MultiApiVersion

impl Decodable for SupportedApiVersionsSummary

impl Decodable for SupportedCoreApiVersions

impl Decodable for SupportedModuleApiVersions

impl Decodable for ApiAnnouncement

impl Decodable for SignedApiAnnouncement

impl Decodable for SignedApiAnnouncementSubmission

impl Decodable for SignedGuardianMetadata

impl Decodable for SignedGuardianMetadataSubmission

impl Decodable for Duration

impl Decodable for AcceptedItem

impl Decodable for SessionOutcome

impl Decodable for SignedSessionOutcome

impl Decodable for PeerSetupCode

impl Decodable for fedimint_core::Amount

impl Decodable for ChainId

impl Decodable for Feerate

impl Decodable for IdxRange

impl Decodable for InPoint

impl Decodable for fedimint_core::OutPoint

impl Decodable for OutPointRange

impl Decodable for PeerId

impl Decodable for TransactionId

impl Decodable for fedimint_core::transaction::Transaction

impl Decodable for TransactionSubmissionOutcome

impl Decodable for TxOutProof

impl Decodable for SafeUrl

impl Decodable for DkgVersion

impl Decodable for NetworkLegacyEncodingWrapper

impl<C> Decodable for Tiered<C>

where C: Decodable,

impl<C> Decodable for TieredMulti<C>

where C: Decodable + 'static,

impl<T> Decodable for DynRawFallback<T>

where T: Decodable + 'static,

impl<T: Encodable + Decodable> Decodable for SerdeModuleEncoding<T>