pub trait Decodable: Sized {
// Provided methods
fn consensus_decode_from_finite_reader<R: BufRead + ?Sized>(
reader: &mut R
) -> Result<Self, Error> { ... }
fn consensus_decode<R: BufRead + ?Sized>(
reader: &mut R
) -> Result<Self, Error> { ... }
}Expand description
Data which can be encoded in a consensus-consistent way.
Provided Methods§
sourcefn consensus_decode_from_finite_reader<R: BufRead + ?Sized>(
reader: &mut R
) -> Result<Self, Error>
fn consensus_decode_from_finite_reader<R: BufRead + ?Sized>( reader: &mut R ) -> Result<Self, Error>
Decode Self from a size-limited reader.
Like consensus_decode 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, 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.
- Types that deserialize using externally provided length should implement it:
- Make
consensus_decodeforward toconsensus_decode_bytes_from_finite_readerwith the reader wrapped byTake. Failure to do so, without other forms of memory exhaustion protection might lead to resource exhaustion vulnerability. - Put a max cap on things like
Vec::with_capacityto avoid oversized allocations, and rely on the reader running out of data, and collections reallocating on a legitimately oversized input data, instead of trying to enforce arbitrary length limits.
- Make
- Types that contain other types that implement custom
consensus_decode_from_finite_reader, should also implement it applying same rules, and in addition make sure to callconsensus_decode_from_finite_readeron all members, to avoid creating redundantTakewrappers. Failure to do so might result only in a tiny performance hit.
sourcefn consensus_decode<R: BufRead + ?Sized>(reader: &mut R) -> Result<Self, Error>
fn consensus_decode<R: BufRead + ?Sized>(reader: &mut R) -> Result<Self, Error>
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 crate::io::Take to limit the input size to MAX_VEC_SIZE, and forwards the call to
Self::consensus_decode_from_finite_reader, which is convenient
for types that override Self::consensus_decode_from_finite_reader
instead.
Object Safety§
This trait is not object safe.
Implementations on Foreign Types§
source§impl Decodable for Vec<PrefilledTransaction>
impl Decodable for Vec<PrefilledTransaction>
source§impl Decodable for Vec<AddrV2Message>
impl Decodable for Vec<AddrV2Message>
source§impl Decodable for Vec<FilterHash>
impl Decodable for Vec<FilterHash>
source§impl Decodable for Vec<FilterHeader>
impl Decodable for Vec<FilterHeader>
source§impl Decodable for Vec<TapLeafHash>
impl Decodable for Vec<TapLeafHash>
source§impl Decodable for Vec<Transaction>
impl Decodable for Vec<Transaction>
source§impl Decodable for Vec<TxMerkleNode>
impl Decodable for Vec<TxMerkleNode>
source§impl<T0: Decodable, T1: Decodable, T2: Decodable, T3: Decodable> Decodable for (T0, T1, T2, T3)
impl<T0: Decodable, T1: Decodable, T2: Decodable, T3: Decodable> Decodable for (T0, T1, T2, T3)
source§impl<T0: Decodable, T1: Decodable, T2: Decodable, T3: Decodable, T4: Decodable> Decodable for (T0, T1, T2, T3, T4)
impl<T0: Decodable, T1: Decodable, T2: Decodable, T3: Decodable, T4: Decodable> Decodable for (T0, T1, T2, T3, T4)
source§impl<T0: Decodable, T1: Decodable, T2: Decodable, T3: Decodable, T4: Decodable, T5: Decodable> Decodable for (T0, T1, T2, T3, T4, T5)
impl<T0: Decodable, T1: Decodable, T2: Decodable, T3: Decodable, T4: Decodable, T5: Decodable> Decodable for (T0, T1, T2, T3, T4, T5)
source§impl<T0: Decodable, T1: Decodable, T2: Decodable, T3: Decodable, T4: Decodable, T5: Decodable, T6: Decodable> Decodable for (T0, T1, T2, T3, T4, T5, T6)
impl<T0: Decodable, T1: Decodable, T2: Decodable, T3: Decodable, T4: Decodable, T5: Decodable, T6: Decodable> Decodable for (T0, T1, T2, T3, T4, T5, T6)
source§impl<T0: Decodable, T1: Decodable, T2: Decodable, T3: Decodable, T4: Decodable, T5: Decodable, T6: Decodable, T7: Decodable> Decodable for (T0, T1, T2, T3, T4, T5, T6, T7)
impl<T0: Decodable, T1: Decodable, T2: Decodable, T3: Decodable, T4: Decodable, T5: Decodable, T6: Decodable, T7: Decodable> Decodable for (T0, T1, T2, T3, T4, T5, T6, T7)
Implementors§
impl Decodable for LockTime
impl Decodable for AddrV2
Available on crate feature
std only.impl Decodable for Inventory
Available on crate feature
std only.impl Decodable for BloomFlags
Available on crate feature
std only.impl Decodable for RejectReason
Available on crate feature
std only.impl Decodable for BlockTransactions
impl Decodable for BlockTransactionsRequest
impl Decodable for HeaderAndShortIds
impl Decodable for PrefilledTransaction
impl Decodable for ShortId
impl Decodable for Header
impl Decodable for bitcoin::block::Version
impl Decodable for ScriptBuf
impl Decodable for MerkleBlock
impl Decodable for PartialMerkleTree
impl Decodable for AddrV2Message
Available on crate feature
std only.impl Decodable for CommandString
Available on crate feature
std only.impl Decodable for RawNetworkMessage
Available on crate feature
std only.impl Decodable for GetBlocksMessage
Available on crate feature
std only.impl Decodable for GetHeadersMessage
Available on crate feature
std only.impl Decodable for FilterAdd
Available on crate feature
std only.impl Decodable for FilterLoad
Available on crate feature
std only.impl Decodable for BlockTxn
Available on crate feature
std only.impl Decodable for CmpctBlock
Available on crate feature
std only.impl Decodable for GetBlockTxn
Available on crate feature
std only.impl Decodable for SendCmpct
Available on crate feature
std only.impl Decodable for CFCheckpt
Available on crate feature
std only.impl Decodable for CFHeaders
Available on crate feature
std only.impl Decodable for CFilter
Available on crate feature
std only.impl Decodable for GetCFCheckpt
Available on crate feature
std only.impl Decodable for GetCFHeaders
Available on crate feature
std only.impl Decodable for GetCFilters
Available on crate feature
std only.impl Decodable for Reject
Available on crate feature
std only.impl Decodable for VersionMessage
Available on crate feature
std only.impl Decodable for Address
Available on crate feature
std only.