Struct ReadOptions 

#[non_exhaustive]
pub struct ReadOptions { /* private fields */ }

Options controlling a read operation.

Examples

use qubit_fs::read::ReadOptions;

let options = ReadOptions::default().with_length(Some(1_024));
assert_eq!(Some(1_024), options.length());
assert!(options.validate().is_ok());

Implementations

impl ReadOptions

pub const fn with_offset(self, offset: Option<u64>) -> Self

Returns a copy with the byte offset replaced.

pub const fn offset(&self) -> Option<u64>

Returns the optional byte offset.

pub const fn with_length(self, length: Option<u64>) -> Self

Returns a copy with the byte length replaced.

pub const fn length(&self) -> Option<u64>

Returns the optional byte length.

pub fn with_if_match(self, if_match: Option<ResourceVersion>) -> Self

Returns a copy with the positive version precondition replaced.

pub const fn if_match(&self) -> Option<&ResourceVersion>

Returns the optional positive version precondition.

pub fn with_if_none_match(self, if_none_match: Option<ResourceVersion>) -> Self

Returns a copy with the negative version precondition replaced.

pub const fn if_none_match(&self) -> Option<&ResourceVersion>

Returns the optional negative version precondition.

pub const fn with_checksum(self, checksum: ChecksumPolicy) -> Self

Returns a copy with the checksum policy replaced.

pub const fn checksum(&self) -> ChecksumPolicy

Returns the checksum policy.

pub fn validate(&self) -> Result<(), FsError>

Validates provider-independent read options without performing I/O.

A zero-length window is valid, including at the largest offset. Resource existence and access permissions are still checked when opening it. Offsets at or beyond EOF produce an empty window; lengths extending past EOF are truncated. These windows do not imply a resource snapshot.

Errors

Returns InvalidOptions for mutually exclusive conditions or an explicit range whose exclusive end cannot be represented as u64.

pub fn validate_against( &self, capabilities: FileSystemCapabilities, ) -> Result<(), FsError>

Validates required read semantics against configured capabilities.

Providers should call this method before opening a reader or producing any observable side effect.

Errors

Returns FsErrorKind::InvalidOptions for mutually exclusive version conditions, or FsErrorKind::RequirementNotMet with the exact missing capability for range, conditional, or required-checksum reads.

Trait Implementations

impl Clone for ReadOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadOptions

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

Formats the value using the given formatter.

impl Default for ReadOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ReadOptions

impl PartialEq for ReadOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ReadOptions