Struct flips::BpsDeltaBuilder

pub struct BpsDeltaBuilder<S: AsRef<[u8]>, T: AsRef<[u8]>, M: AsRef<[u8]> = &'static [u8]> { /* fields omitted */ }

A builder to create a BPS patch.

This type is as generic as possible, making it easy to use any type that can be viewed as a slice of bytes.

Example

let patch = flips::BpsLinearBuilder::new()
    .source(&b"some source bytes"[..])
    .target(&b"some target bytes"[..])
    .build()
    .expect("could not create patch");

Methods

impl<S: AsRef<[u8]>, T: AsRef<[u8]>> BpsDeltaBuilder<S, T, &'static [u8]>

pub fn new() -> Self

Create a new builder for an BPS patch.

pub fn metadata<M: AsRef<[u8]>, B: Into<Option<M>>>(
    &mut self,
    buffer: B
) -> BpsDeltaBuilder<S, T, M>

Set the metadata buffer for the patch, if any.

impl<S: AsRef<[u8]>, T: AsRef<[u8]>, M: AsRef<[u8]>> BpsDeltaBuilder<S, T, M>

pub fn source(&mut self, source: S) -> &mut Self

Set the source buffer for the patch.

pub fn more_memory(&mut self, moremem: bool) -> &mut Self

Enable the patcher to use more memory.

According to the Flips documentation, enabling more memory for the delta patcher results in about 5x the size of the patch to be used as memory.

pub fn target(&mut self, target: T) -> &mut Self

Set the target buffer for the patch.

#[must_use]pub fn build(&mut self) -> Result<BpsPatch<FlipsMemory>>

Build an BPS patch from source to target with metadata if any.

Error

If either source or target was not given, this method will return Error::Canceled.

Trait Implementations

impl<S: Clone + AsRef<[u8]>, T: Clone + AsRef<[u8]>, M: Clone + AsRef<[u8]>> Clone for BpsDeltaBuilder<S, T, M>

fn clone(&self) -> BpsDeltaBuilder<S, T, M>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: Debug + AsRef<[u8]>, T: Debug + AsRef<[u8]>, M: Debug + AsRef<[u8]>> Debug for BpsDeltaBuilder<S, T, M>

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

Formats the value using the given formatter.

impl<S: Default + AsRef<[u8]>, T: Default + AsRef<[u8]>, M: Default + AsRef<[u8]>> Default for BpsDeltaBuilder<S, T, M>

fn default() -> BpsDeltaBuilder<S, T, M>

Returns the "default value" for a type.