#[non_exhaustive]pub struct WriteOptions { /* private fields */ }Expand description
Options controlling a write operation.
By default, create_parent is false, disposition is
WriteDisposition::CreateOrReplace, atomicity is
AtomicityRequirement::Preferred, durability is
DurabilityRequirement::NotRequired, and precondition is
WritePrecondition::None. Content type and checksum are None, and user
metadata is empty. These are request policies; provider support and
successful completion are reported separately.
§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());Refuse to replace an existing destination:
use qubit_fs::write::WriteDisposition;
use qubit_fs::write::WriteOptions;
let options = WriteOptions::default()
.with_disposition(WriteDisposition::CreateNew);
assert_eq!(options.disposition(), WriteDisposition::CreateNew);Implementations§
Source§impl WriteOptions
impl WriteOptions
Sourcepub const fn create_parent(&self) -> bool
pub const fn create_parent(&self) -> bool
Returns whether missing parent directories are created.
Sourcepub const fn disposition(&self) -> WriteDisposition
pub const fn disposition(&self) -> WriteDisposition
Returns the destination disposition.
Sourcepub const fn atomicity(&self) -> AtomicityRequirement
pub const fn atomicity(&self) -> AtomicityRequirement
Returns the atomicity requirement.
Sourcepub const fn durability(&self) -> DurabilityRequirement
pub const fn durability(&self) -> DurabilityRequirement
Returns the completed-publication durability requirement.
Sourcepub const fn precondition(&self) -> &WritePrecondition
pub const fn precondition(&self) -> &WritePrecondition
Returns the version precondition.
Sourcepub fn content_type(&self) -> Option<&str>
pub fn content_type(&self) -> Option<&str>
Returns the optional content type.
Sourcepub const fn user_metadata(&self) -> &NonSensitiveMetadata
pub const fn user_metadata(&self) -> &NonSensitiveMetadata
Returns the user metadata attached to this write.
Sourcepub const fn with_create_parent(self, create: bool) -> Self
pub const fn with_create_parent(self, create: bool) -> Self
Returns a copy with parent creation replaced.
§Parameters
create: Whether parent directories should be created.
Sourcepub const fn with_disposition(self, disposition: WriteDisposition) -> Self
pub const fn with_disposition(self, disposition: WriteDisposition) -> Self
Returns a copy with the destination disposition replaced.
§Parameters
disposition: Destination creation or replacement behavior.
Sourcepub const fn with_atomicity(self, atomicity: AtomicityRequirement) -> Self
pub const fn with_atomicity(self, atomicity: AtomicityRequirement) -> Self
Returns a copy with the atomicity requirement replaced.
§Parameters
atomicity: Required atomic publication behavior.
Sourcepub const fn with_durability(self, durability: DurabilityRequirement) -> Self
pub const fn with_durability(self, durability: DurabilityRequirement) -> Self
Returns a copy with the durability requirement replaced.
§Parameters
durability: Required durability after publication.
Sourcepub fn with_precondition(self, precondition: WritePrecondition) -> Self
pub fn with_precondition(self, precondition: WritePrecondition) -> Self
Returns a copy with the version precondition replaced.
§Parameters
precondition: Version condition required before publication.
Sourcepub fn with_content_type(self, content_type: Option<String>) -> Self
pub fn with_content_type(self, content_type: Option<String>) -> Self
Returns a copy with the content type replaced.
§Parameters
content_type: Optional content type associated with the new file.
Sourcepub fn with_checksum(self, checksum: Option<Checksum>) -> Self
pub fn with_checksum(self, checksum: Option<Checksum>) -> Self
Returns a copy with the expected checksum replaced.
§Parameters
checksum: Optional expected checksum for the written content.
Sourcepub fn with_user_metadata(self, metadata: UserMetadata) -> Self
pub fn with_user_metadata(self, metadata: UserMetadata) -> Self
Replaces user-defined metadata that has already passed key validation.
§Parameters
metadata: Validated user metadata associated with the new file.
Sourcepub fn validate(&self) -> Result<(), FsError>
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.
Sourcepub fn validate_against(
&self,
capabilities: FileSystemCapabilities,
) -> Result<(), FsError>
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.
§Parameters
capabilities: Capabilities against which the requested policy is checked.