Struct glommio::io::ImmutableFilePreSealSink

pub struct ImmutableFilePreSealSink { /* fields omitted */ }

Sink portion of the ImmutableFile

To build it, use build_sink on the ImmutableFileBuilder

Implementations

impl ImmutableFilePreSealSink

pub async fn seal(self) -> Result<ImmutableFile, ()>

Seals the file for further writes.

Once this is called, it is no longer possible to write to the resulting ImmutableFile

pub async fn flush_aligned(&self) -> Result<u64, ()>

Waits for all currently in-flight buffers to be written to the underlying storage.

This does not include the current buffer if it is not full. If all data must be flushed, use flush.

Returns the flushed position of the file.

pub async fn sync_aligned(&self) -> Result<u64, ()>

Waits for all currently in-flight buffers to be written to the underlying storage, and ensures they are safely persisted.

This does not include the current buffer if it is not full. If all data must be synced, use Self::sync.

Returns the flushed position of the file at the time the sync started.

pub async fn sync(&self) -> Result<u64, ()>

Waits for all buffers to be written to the underlying storage, and ensures they are safely persisted.

This includes the current buffer even if it is not full, by padding it. The padding will get over-written by future writes, or truncated upon Self::seal or close.

Returns the flushed position of the file at the time the sync started.

pub fn current_pos(&self) -> u64

Acquires the current position of this ImmutableFilePreSealSink.

pub fn current_flushed_pos(&self) -> u64

Acquires the current position of this ImmutableFilePreSealSink that is flushed to the underlying media.

Warning: the position reported by this API is not restart or crash safe. You need to call ImmutableFilePreSealSink::sync for that. Although the ImmutableFilePreSealSink uses Direct I/O, modern storage devices have their own caches and may still lose data that sits on those caches upon a restart until ImmutableFilePreSealSink::sync is called (Note that ImmutableFilePreSealSink::seal implies a sync).

However within the same session, new readers trying to read from any position before what we return in this method will be guaranteed to read the data we just wrote.

Trait Implementations

impl AsyncWrite for ImmutableFilePreSealSink

fn poll_write(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    buf: &[u8]
) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to close the object.

fn poll_write_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    bufs: &[IoSlice<'_>]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl Debug for ImmutableFilePreSealSink

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

Formats the value using the given formatter.