Skip to main content

BundleStreamWriter

Struct BundleStreamWriter 

Source
pub struct BundleStreamWriter<W: Write> { /* private fields */ }
Expand description

A streaming v2 bundle writer: writes the MANIFEST up front, then appends members ONE AT A TIME (append_member), each from a bounded staging temp the caller may delete the instant the call returns — so the node never holds more than the largest single member. The export driver drives it from a blocking task, staging each member just before it appends and deleting the temp just after (see the convenience wrapper write_bundle_streaming, which encapsulates exactly that produce→append→delete loop).

Implementations§

Source§

impl<W: Write> BundleStreamWriter<W>

Source

pub fn new( out: W, created_at: u64, data_only: bool, source: SourceInfo, specs: Vec<MemberSpec>, ) -> Result<Self, BundleError>

Begin a streamable bundle on out, writing the MANIFEST (the ordered member list) first. specs is every member in restore order; each must then be supplied, in that order, via append_member (Sidecar framing) or append_member_chunked (ChunkedTrailer framing) to match the spec’s declared framing, and the bundle closed with finish. The MANIFEST declares BUNDLE_FORMAT_VERSION_V3 when ANY member is chunked, else BUNDLE_FORMAT_VERSION_V2 — so a bundle with no chunked member is byte-identical to the pre-v3 v2 form (an inc1 node can still read it).

Source

pub fn append_member( &mut self, path: &str, kind: MemberKind, src: &Path, ) -> Result<(), BundleError>

Append the next member, whose bytes are staged at src (a bounded temp). Writes the member’s .brmeta sidecar (size + SHA-256, read from src) then the member data, both streamed from src (never buffered whole). The path/kind MUST match the next member the MANIFEST declared — an out-of-order or unexpected append is refused loud.

Source

pub fn append_member_chunked( &mut self, path: &str, kind: MemberKind, body: &mut dyn Read, chunk_size: usize, ) -> Result<(), BundleError>

Append the next member as a run of chunk_size-byte .part{N} tar entries followed by a .brtrailer (MemberTrailer: size + SHA-256). Streams body through, hashing + counting WHILE writing each chunk — it NEVER stats or buffers the whole member (at most one chunk_size buffer lives at a time), so a producer that yields a &mut dyn Read over an engine dump (the libsql .dump stream, pg_dump stdout) is written in O(chunk) disk + memory. The path/kind MUST match the next declared member AND its framing MUST be MemberFraming::ChunkedTrailer — an out-of-order, unexpected, or wrong-framing append is refused loud. chunk_size must be non-zero.

Source

pub fn finish(self) -> Result<(), BundleError>

Finish the bundle: refuse if any declared member was never appended, then flush.

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