Struct WriteOptions 

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

Options controlling a write operation.

Examples

use qubit_fs::write::WriteOptions;
use qubit_fs::metadata::AtomicityRequirement;
use qubit_fs::metadata::FileSystemCapabilities;
let options = WriteOptions::default().with_atomicity(AtomicityRequirement::Required);
assert!(options.validate_against(FileSystemCapabilities::new()).is_err());

Implementations

impl WriteOptions

pub const fn with_create_parent(self, create: bool) -> Self

Returns a copy with parent creation replaced.

pub const fn create_parent(&self) -> bool

Returns whether missing parent directories are created.

pub const fn with_disposition(self, disposition: WriteDisposition) -> Self

Returns a copy with the destination disposition replaced.

pub const fn disposition(&self) -> WriteDisposition

Returns the destination disposition.

pub const fn with_atomicity(self, atomicity: AtomicityRequirement) -> Self

Returns a copy with the atomicity requirement replaced.

pub const fn atomicity(&self) -> AtomicityRequirement

Returns the atomicity requirement.

pub const fn with_durability(self, durability: DurabilityRequirement) -> Self

Returns a copy with the durability requirement replaced.

pub const fn durability(&self) -> DurabilityRequirement

Returns the completed-publication durability requirement.

pub fn with_precondition(self, precondition: WritePrecondition) -> Self

Returns a copy with the version precondition replaced.

pub const fn precondition(&self) -> &WritePrecondition

Returns the version precondition.

pub fn with_content_type(self, content_type: Option<String>) -> Self

Returns a copy with the content type replaced.

pub fn content_type(&self) -> Option<&str>

Returns the optional content type.

pub const fn user_metadata(&self) -> &NonSensitiveMetadata

Returns the user metadata attached to this write.

pub fn with_checksum(self, checksum: Option<Checksum>) -> Self

Returns a copy with the expected checksum replaced.

pub const fn checksum(&self) -> Option<&Checksum>

Returns the optional expected checksum.

pub fn with_user_metadata(self, metadata: UserMetadata) -> Self

Replaces user-defined metadata that has already passed key validation.

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

Validates combinations that have no coherent provider interpretation.

Errors

Returns FsErrorKind::InvalidOptions before a writer is opened when append is combined with atomic publication or a version precondition, or when create-new is combined with an existing-version requirement.

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

Validates write options against stable configured capabilities.

Providers should call this before opening a write session. In particular, required atomic publication is rejected before any staging write when FileSystemCapability::AtomicReplace is absent.

Errors

Returns invalid-option errors from Self::validate, or a typed FsErrorKind::RequirementNotMet for unsupported append, conditional, or required-atomic writes.

Trait Implementations

impl Clone for WriteOptions

fn clone(&self) -> WriteOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WriteOptions

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

Formats the value using the given formatter.

impl Default for WriteOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for WriteOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for WriteOptions