Skip to main content

WriteBatch

Struct WriteBatch 

Source
pub struct WriteBatch<'s> { /* private fields */ }
Expand description

A set of object writes that become durable and visible together. Created by ObjectStore::batch. See the module docs for the durability contract.

Implementations§

Source§

impl<'s> WriteBatch<'s>

Source

pub fn write(&self, bytes: &[u8]) -> StoreResult<Hash>

Hash bytes, dedup against staged and on-disk objects, and stage (policy Batch/None) or durably write (policy PerObject) the object. Returns the BLAKE3 hash either way.

Source

pub fn write_parts(&self, parts: &[&[u8]]) -> StoreResult<Hash>

Self::write for an object whose bytes are the concatenation of parts, hashed and written streaming — no concatenated buffer is materialised.

§Panics

Panics only if the internal hash-to-path mapping produces a path without a parent directory (impossible by construction) or if a previous write panicked while holding the batch mutex.

Source

pub fn contains(&self, h: &Hash) -> bool

True when h is staged in this batch or already in the store.

§Panics

Panics only if a previous write panicked while holding the batch mutex.

Source

pub fn commit(self) -> StoreResult<()>

Make every staged object durable and visible: one full flush, then all renames, then deduplicated shard-directory flushes.

After commit() returns Ok, every hash returned by Self::write/Self::write_parts is durable AND visible. Callers MUST call this before reading any object written by this batch and before writing any ref/index that references one.

If commit() fails partway, already-renamed objects remain visible (content-addressing makes re-running the command idempotent) and not-yet-renamed temp files are unlinked on drop.

§Panics

Panics only if a previous write panicked while holding the batch mutex.

Trait Implementations§

Source§

impl<'s> Debug for WriteBatch<'s>

Source§

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

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

impl ObjectSink for WriteBatch<'_>

Source§

fn put(&self, bytes: &[u8]) -> StoreResult<Hash>

Store bytes as one object, returning its BLAKE3 hash.
Source§

fn put_parts(&self, parts: &[&[u8]]) -> StoreResult<Hash>

Store the concatenation of parts as one object without the caller having to materialise the concatenated buffer.
Source§

fn has(&self, h: &Hash) -> bool

True when the object is already present (or staged) in this sink.

Auto Trait Implementations§

§

impl<'s> !Freeze for WriteBatch<'s>

§

impl<'s> !RefUnwindSafe for WriteBatch<'s>

§

impl<'s> !UnwindSafe for WriteBatch<'s>

§

impl<'s> Send for WriteBatch<'s>

§

impl<'s> Sync for WriteBatch<'s>

§

impl<'s> Unpin for WriteBatch<'s>

§

impl<'s> UnsafeUnpin for WriteBatch<'s>

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

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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> 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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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