Struct Jagged2Builder

pub struct Jagged2Builder<T> { /* private fields */ }

Struct to facilitate building a jagged array row by row.

Example

use jagged_array::{Jagged2, Jagged2Builder};

let mut builder = Jagged2Builder::new();
builder.extend(&[1, 2]); // push an array/slice
builder.extend((0..2)); // push an iterator (range)
builder.extend(vec![3]); // push and consume a vector

// Finalize the builder into an array.
let array: Jagged2<u32> = builder.into();

assert_eq!(array.len(), 3);
assert_eq!(array.get_row(0), Some(&[1, 2][..]));
assert_eq!(array.get_row(1), Some(&[0, 1][..]));
assert_eq!(array.get_row(2), Some(&[3][..]));

Implementations

impl<T> Jagged2Builder<T>

pub fn new() -> Self

Construct a new array builder, defaulted to not holding any rows.

pub fn with_capacity(row_cap: usize, item_cap: usize) -> Self

Construct an empty array builder, but preallocate enough heap space for row_cap rows, and a total of item_cap items stored cumulatively in the array.

Adding more rows/items than specified after using this constructor is not an error; more space will be allocated on demand.

pub fn len(&self) -> usize

Return the number of rows held in the array builder.

pub fn flat_len(&self) -> usize

Return the total number of T held in the array.

pub fn resize(&mut self, new_len: usize)

If new_len < self.len(), the array will be extended with empty rows until it reaches the given length. Otherwise, rows will be truncated from the tail of the array until the length is reached.

Example

use jagged_array::Jagged2Builder;
let mut builder: Jagged2Builder<u32> = Jagged2Builder::new();
builder.extend(&[1, 2]);
builder.extend(&[3]);
builder.resize(4);
let mut expected: Jagged2Builder<u32> = Jagged2Builder::new();
expected.extend(&[1, 2]);
expected.extend(&[3]);
expected.extend(&[]);
expected.extend(&[]);
assert_eq!(builder, expected);

Trait Implementations

impl<T: Clone> Clone for Jagged2Builder<T>

fn clone(&self) -> Jagged2Builder<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Jagged2Builder<T>

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

Formats the value using the given formatter.

impl<T> Default for Jagged2Builder<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, T> Extend<&'a T> for Jagged2Builder<T>

where T: 'a + Copy,

fn extend<I>(&mut self, row: I)

where I: IntoIterator<Item = &'a T>,

Push a new row into the builder; this also works for array/slice types passed by reference, if T is Copy.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T> Extend<T> for Jagged2Builder<T>

fn extend<I>(&mut self, row: I)

where I: IntoIterator<Item = T>,

Push a new row into the builder

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T: Hash> Hash for Jagged2Builder<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Into<Jagged2<T>> for Jagged2Builder<T>

fn into(self) -> Jagged2<T>

Converts this type into the (usually inferred) input type.

impl<T: PartialEq> PartialEq for Jagged2Builder<T>

fn eq(&self, other: &Jagged2Builder<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Eq> Eq for Jagged2Builder<T>

impl<T> StructuralPartialEq for Jagged2Builder<T>