Skip to main content

PlanBuilder

Struct PlanBuilder 

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

Accumulating builder for a multi-patch Plan.

Construct via PlanBuilder::new, feed each patch in chain order via PlanBuilder::add_patch, then consume with PlanBuilder::finish. For a one-shot single-patch build, the three-line dance PlanBuilder::new().add_patch(name, reader)?.finish() (the add_patch call returning &mut Self is not supported — use a let mut) is the canonical form; there is no freestanding convenience wrapper.

Implementations§

Source§

impl PlanBuilder

Source

pub fn new() -> Self

Start a new, empty builder.

Source

pub fn add_patch<R: Read>( &mut self, name: impl Into<String>, reader: ZiPatchReader<R>, ) -> Result<()>

Read reader to completion, appending the patch to the chain.

Mid-chain destructive ops (RemoveAll, DeleteFile, AddFile@file_offset=0) retroactively prune accumulated regions from earlier patches at this point.

§Errors
  • IndexError::DuplicatePatch if name matches a patch already added to this builder. The chain protocol is order-sensitive; adding the same patch twice is almost always a caller bug.
  • Any parser error surfaced by reader.next_chunk().
§Panics

Panics if the chain grows past u32::MAX patches.

Source

pub fn finish(self) -> Plan

Consume the builder and return the accumulated Plan.

Emits a single info! summary event carrying the final patch / target / region / fs_op counts so a subscriber sees one completion record per fully-built plan regardless of how many add_patch calls fed it.

Trait Implementations§

Source§

impl Debug for PlanBuilder

Source§

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

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

impl Default for PlanBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. 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<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 = 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<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