Struct PrefixReadOutcome 

pub struct PrefixReadOutcome { /* private fields */ }

Bytes read from one opened resource together with bounded-read facts.

LimitReached means the requested bound was consumed without probing for another byte; it does not prove that the stream has ended.

Examples

use qubit_fs::Path;
use qubit_fs::read::PrefixReadTermination;
use qubit_fs::read::ReadOptions;
let fs = support::rustdoc_provider::filesystem();
let outcome = fs.read_prefix(&Path::parse("/report")?, ReadOptions::default(), 3)?;
assert_eq!(outcome.bytes(), b"rep");
assert_eq!(outcome.termination(), PrefixReadTermination::LimitReached);

Implementations

impl PrefixReadOutcome

pub fn bytes(&self) -> &[u8]

Returns the bytes without transferring ownership.

pub const fn info(&self) -> &OpenedFileInfo

Returns the information captured when the reader was opened.

pub const fn options(&self) -> &ReadOptions

Returns the caller options retained for this read.

pub const fn max_bytes(&self) -> usize

Returns the requested prefix limit.

pub const fn termination(&self) -> PrefixReadTermination

Returns the reason the read stopped.

pub fn into_bytes(self) -> Vec<u8>

Transfers the accumulated bytes without another allocation.

Trait Implementations

impl Debug for PrefixReadOutcome

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

Formats the value using the given formatter.