Skip to main content

decode_from_read_unbuffered

bitcoin_consensus_encoding

Function decode_from_read_unbuffered 

Source 
pub fn decode_from_read_unbuffered<T, R>(
    reader: R,
) -> Result<T, ReadError<<T::Decoder as Decoder>::Error>>
where
    T: Decodable,
    R: Read,
Expand description

Decodes an object from an unbuffered reader using a fixed-size buffer.

For most use cases, prefer decode_from_read with a std::io::BufReader. This function is only needed when you have an unbuffered reader which you cannot wrap. It will probably have worse performance.

§Buffer

Uses a fixed 4KB (4096 bytes) stack-allocated buffer that is reused across read operations. This size is a good balance between memory usage and system call efficiency for most use cases.

For different buffer sizes, use decode_from_read_unbuffered_with.

§Errors

Returns ReadError::Decode if the decoder encounters an error while parsing the data, or ReadError::Io if an I/O error occurs while reading.