Skip to main content

StreamPacker

Struct StreamPacker 

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

Streaming packer that emits completed packs incrementally.

§Example

use seqpacker::stream::{StreamPacker, StreamStrategy};

let mut sp = StreamPacker::new(10, StreamStrategy::NextFit);

// Each add() may return closed packs.
let closed = sp.add(7).unwrap();
assert!(closed.is_empty()); // bin still open

let closed = sp.add(5).unwrap(); // 5 > remaining 3 → closes bin
assert_eq!(closed.len(), 1);
assert_eq!(closed[0].used_capacity(), 7);

// finish() flushes the last open bin.
let remaining = sp.finish();
assert_eq!(remaining.len(), 1);
assert_eq!(remaining[0].used_capacity(), 5);

Implementations§

Source§

impl StreamPacker

Source

pub fn new(capacity: usize, strategy: StreamStrategy) -> Self

Create a new streaming packer.

Source

pub fn with_k(capacity: usize, strategy: StreamStrategy, k: usize) -> Self

Create a streaming packer with a custom k for Harmonic.

k is ignored for NextFit.

Source

pub fn add(&mut self, length: usize) -> Result<Vec<Pack>>

Add a sequence length and return any packs that are now complete.

§Errors

Returns PackError::SequenceTooLong if length exceeds capacity.

Source

pub fn finish(self) -> Vec<Pack>

Flush all remaining open bins and return them as packs.

Source

pub fn sequences_added(&self) -> usize

Number of sequences added so far.

Source

pub fn strategy(&self) -> StreamStrategy

The streaming strategy in use.

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