Struct LocalSink 

pub struct LocalSink { /* private fields */ }

A local file opened for both directions, so the zoom pass reads back through the handle that wrote.

Implementations

impl LocalSink

pub fn create(path: impl AsRef<Path>) -> Result<Self>

pub fn discard(&mut self)

Drop the handle and remove the file, without flushing what is staged.

What a writer that has given up wants: create truncated the path at open, so leaving quietly still leaves a zero-magic stub behind that the caller has to clean up. Nothing staged is worth writing to a file about to be unlinked.

The handle goes first because Windows refuses to remove an open file. A removal that fails — the path already gone, a directory that is not writable — is not reported: this is the cleanup path of an error that is already on its way to the caller, and a second error would only hide the first.

pub fn as_source(&mut self) -> Result<SinkSource<'_>>

A read view over what has been written, for the zoom pass. Flushes first, so the view never lags the writer.

Trait Implementations

impl ByteSink for LocalSink

fn path(&self) -> &str

fn append(&mut self, data: &[u8]) -> Result<u64>

Append, returning the offset the data landed at.

fn write_all_at(&mut self, offset: u64, data: &[u8]) -> Result<()>

Overwrite bytes already written — a reserved header field, an item count.

fn position(&self) -> u64

Bytes written so far, which is also the offset the next append lands at.

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

fn close(&mut self) -> Result<()>

Finish. Idempotent, and also called from Drop — but a Drop that fails cannot report, so the writer’s own close() is what callers use and what returns the error.

impl Debug for LocalSink

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

Formats the value using the given formatter.

impl Drop for LocalSink

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.