Skip to main content

read_binary_stream

Function read_binary_stream 

Source
pub fn read_binary_stream<Provider: SegmentProvider + ?Sized>(
    provider: &Provider,
    identifier: RecordIdentifier,
) -> Result<BinaryStream<'_, Provider>>
Expand description

Opens a bounded-memory stream over an inline binary value.

The returned stream borrows provider and implements io::Read. Its own memory use is constant regardless of the binary’s declared length; caller-provided read buffers determine the amount copied at a time. Requesting a short-identifier external binary fails with Error::ExternalBinaryContentUnavailable. A long-identifier external binary fails with Error::ExternalBinaryContentUnavailableByRecord without following or materializing its identifier string record. This keeps opening a stream bounded even when that string record is hostile or unavailable.