Skip to main content

StreamingFileWriter

Struct StreamingFileWriter 

Source
pub struct StreamingFileWriter { /* private fields */ }
Expand description

Async buffered disk writer that streams data directly to a temporary .lanflare-part file while concurrently calculating the SHA-256 hash incrementally in memory.

Implementations§

Source§

impl StreamingFileWriter

Source

pub async fn create( target_path: impl Into<PathBuf>, expected_size: Option<u64>, expected_sha256: Option<String>, ) -> Result<Self, StorageError>

Creates a new streaming file writer. Overwrites target file if it already exists.

Source

pub async fn create_with_overwrite( target_path: impl Into<PathBuf>, expected_size: Option<u64>, expected_sha256: Option<String>, allow_overwrite: bool, ) -> Result<Self, StorageError>

Creates a new streaming file writer with optional overwrite protection.

Source

pub async fn create_with_capacity( target_path: impl Into<PathBuf>, expected_size: Option<u64>, expected_sha256: Option<String>, buffer_capacity: usize, ) -> Result<Self, StorageError>

Creates a new streaming file writer with custom buffer capacity.

Source

pub fn target_path(&self) -> &Path

Returns the target destination path.

Source

pub fn temp_path(&self) -> &Path

Returns the temporary file path currently being written to.

Source

pub fn bytes_written(&self) -> u64

Returns the total number of bytes written so far.

Source

pub fn expected_size(&self) -> Option<u64>

Returns the expected size in bytes, if specified.

Source

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

Returns the expected SHA-256 hash, if specified.

Source

pub async fn write_chunk(&mut self, chunk: &[u8]) -> Result<(), StorageError>

Writes a single chunk to disk and updates the running SHA-256 digest.

Source

pub async fn write_all_from_stream<S, B, E>( &mut self, stream: S, ) -> Result<(), StorageError>
where S: Stream<Item = Result<B, E>> + Unpin, B: AsRef<[u8]>, E: Display,

Streams chunks from an asynchronous stream and writes them directly to disk.

Source

pub async fn write_all_from_reader<R>( &mut self, reader: R, ) -> Result<(), StorageError>
where R: AsyncRead + Unpin,

Reads all data from an AsyncRead source and writes it to disk.

Source

pub async fn commit(self) -> Result<StorageCommitResult, StorageError>

Flushes data, verifies size and SHA-256 checksum, and atomically renames the temporary .lanflare-part file to the final destination path.

Source

pub async fn abort(self) -> Result<(), StorageError>

Aborts writing and immediately removes the temporary file from disk.

Trait Implementations§

Source§

impl Debug for StreamingFileWriter

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for StreamingFileWriter

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

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. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more