Struct FileWriter 

pub struct FileWriter { /* private fields */ }

Type-erased provider write session explicitly associated with a file.

Examples

This example uses an isolated in-memory provider fixture.

use qubit_fs::Path;
use qubit_fs::write::WriteOptions;
use qubit_fs::write::WriterState;
use qubit_io::Output;

let mut writer = filesystem.open_writer(&Path::parse("/new-report")?, WriteOptions::default())?;
writer.write_fully(b"report")?;
let outcome = writer.commit()?;
assert_eq!(Some(6), outcome.bytes_written());
assert_eq!(WriterState::Committed, writer.state());

Implementations

impl FileWriter

pub fn info(&self) -> &OpenedFileInfo

Returns the fixed identity and open-time metadata snapshot.

Returns

Information captured when the writer was opened.

pub const fn state(&self) -> WriterState

Returns the current lifecycle state.

Returns

Current writer state.

pub fn commit(&mut self) -> Result<WriteOutcome, WriteFailure>

Publishes bytes accepted by this session.

This method borrows rather than consumes the writer. The provider’s typed failure determines whether retry remains safe or only explicit cleanup is available.

Returns

Actual publication method and atomicity on success.

Errors

Returns FsErrorKind::InvalidState after commit or abort, or the provider publication error.

pub fn abort(&mut self) -> FsResult<WriteAbortOutcome>

Aborts this writer and releases provider staging resources.

Abort is allowed while open and after every failed commit. Successful cleanup does not imply that an already-published target was rolled back. An indeterminate abort disables automatic drop cleanup so the caller can inspect provider state before choosing a recovery action.

Returns

Provider-confirmed destination publication state after cleanup.

Errors

Returns FsErrorKind::InvalidState after commit or a previous abort, or returns the provider cleanup error while retaining the session.

Trait Implementations

impl Debug for FileWriter

fn fmt(&self, formatter: &mut Formatter<'_>) -> FmtResult

Formats the value using the given formatter.

impl Drop for FileWriter

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Output for FileWriter

type Item = u8

The item type written to this output.

fn is_buffered(&self) -> bool

Returns whether this output already buffers items internally.

unsafe fn write_unchecked( &mut self, input: &[u8], index: usize, count: usize, ) -> IoResult<usize>

Writes items from an indexed input range without checking the range.

fn flush(&mut self) -> IoResult<()>

Flushes any internally buffered items.

fn write(&mut self, input: &[Self::Item]) -> Result<usize, Error>

Writes items from the full input slice.

unsafe fn write_fully_unchecked( &mut self, input: &[Self::Item], index: usize, count: usize, ) -> Result<(), Error>

Writes all items from an indexed input range.

fn write_fully(&mut self, input: &[Self::Item]) -> Result<(), Error>

Writes all items from the full input slice.