Skip to main content

WriteHandle

Struct WriteHandle 

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

One destination file, open for concurrent positional writes.

Implementations§

Source§

impl WriteHandle

Source

pub fn open_cloned( final_path: &Path, size: u64, preallocate: bool, ) -> Result<Self>

Open the partial file, seeding it from an existing copy where the filesystem can do that for free.

Delta sync reuses most blocks of an unchanged file, and the receiver would otherwise copy every one of them out of the old file and into the new one — gigabytes of local I/O to reproduce bytes that are already on the disk. A copy-on-write clone shares the extents instead, so the seeding is O(1) and only the chunks that genuinely differ are written. Where the filesystem cannot clone, this falls back to the ordinary path and the per-chunk copies happen as before.

Source

pub fn open(final_path: &Path, size: u64, preallocate: bool) -> Result<Self>

Open (or reopen) the partial file for final_path, sized to size.

Source

pub fn size(&self) -> u64

Source

pub fn part_path(&self) -> &Path

Source

pub fn created_new(&self) -> bool

Whether this session created the partial file, and can therefore assume unwritten regions read as zeros.

Source

pub fn write_zeros_at(&self, offset: u64, len: usize) -> Result<()>

Write len zero bytes at offset without allocating a buffer that big.

Source

pub fn write_at(&self, offset: u64, buf: &[u8]) -> Result<()>

Write buf at offset. Safe to call concurrently from many threads.

Source

pub fn read_at(&self, offset: u64, buf: &mut [u8]) -> Result<usize>

Source

pub fn matches_at(&self, offset: u64, want: &[u8]) -> Result<bool>

Is want already what the file holds at offset?

Used to avoid rewriting bytes a copy-on-write clone already shares: writing them would break the sharing and cost the very I/O the clone was there to avoid.

Source

pub fn sync(&self) -> Result<()>

Flush to stable storage. Called once per file, not per chunk — an fsync per chunk would dominate the cost of the transfer.

Source

pub fn commit( &self, mode: u32, mtime: i64, preserve_metadata: bool, ) -> Result<()>

Rename the partial file into place and apply metadata.

Takes &self rather than self because several workers may still hold a clone of the Arc around this handle when the last chunk lands. Renaming a file that is still open is safe on unix, and on Windows too: Rust’s OpenOptions opens with FILE_SHARE_DELETE. Callers guarantee this runs once per file.

Source

pub fn discard(&self)

Delete the partial file. Used when a transfer aborts unrecoverably.

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<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<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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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<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