Struct ReadOptions 

pub struct ReadOptions { /* private fields */ }

Fluent configuration must be retained; discarding a changed copy is diagnosed.

#![deny(unused_must_use)]
use vfsi_core::api::ReadOptions;
let options = ReadOptions::new();
options.with_max_total_bytes(std::num::NonZeroUsize::new(4096).unwrap());

Aggregate logical byte budget, defaulting to the client’s policy (16 MiB). Range request lengths must fit even if EOF returns fewer bytes. Complete files share the remaining returned-data budget and fail rather than truncate.

use std::num::NonZeroUsize;
use vfsi_core::api::ReadOptions;
let inherited = ReadOptions::new();
let limited = inherited.with_max_total_bytes(NonZeroUsize::new(4096).unwrap());
assert_eq!(limited.max_total_bytes(), NonZeroUsize::new(4096));
assert_eq!(limited.max_total_bytes_or(8192), 4096);
assert_eq!(inherited.max_total_bytes(), None);
assert_eq!(inherited.max_total_bytes_or(8192), 8192);

Overrides require an explicitly validated nonzero value.

use vfsi_core::api::ReadOptions;
ReadOptions::new().with_max_total_bytes(std::num::NonZeroUsize::new(0));

Implementations

impl ReadOptions

pub const fn new() -> ReadOptions

Inherit the client’s aggregate read budget.

pub const fn with_max_total_bytes(self, bytes: NonZero<usize>) -> ReadOptions

Override the aggregate budget for this call. New options inherit client policy. Only nonzero overrides are representable. Stream larger files instead of raising this when bounded memory is required.

pub const fn max_total_bytes(self) -> Option<NonZero<usize>>

Return the configured override, not the effective client budget. None inherits the client’s budget; it does not mean unlimited.

pub fn max_total_bytes_or(self, default: usize) -> usize

Resolve an inherited aggregate budget against the client’s default.

Trait Implementations

impl Clone for ReadOptions

fn clone(&self) -> ReadOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for ReadOptions

impl Debug for ReadOptions

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

Formats the value using the given formatter.

impl Default for ReadOptions

fn default() -> ReadOptions

Returns the “default value” for a type.

impl Eq for ReadOptions

impl PartialEq for ReadOptions

fn eq(&self, other: &ReadOptions) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ReadOptions