Struct growable::GrowablePoolBuilder

pub struct GrowablePoolBuilder { /* fields omitted */ }

A customizable GrowablePool builder.

Examples

  let _ = GrowablePool::builder()
      .with_default_capacity(128)
      .with_default_ptr_alignment(16)
      .with_capacity(512)
      .enable_overgrow(true)
      .build();

Methods

impl GrowablePoolBuilder

pub fn new() -> Self

Creates a new pool builder with default options.

pub fn enable_overgrow(&mut self, enable: bool) -> &mut Self

If set to false all returning Growable will be dropped if there is not enough free space available in a pool.

pub fn with_default_capacity(&mut self, len: usize) -> &mut Self

Sets the default capacity for each allocated Growable.

pub fn with_default_ptr_alignment(&mut self, ptr_alignment: usize) -> &mut Self

Sets the default ptr alignment for each allocated Growable.

pub fn with_capacity(&mut self, capacity: usize) -> &mut Self

Sets a pool capacity used for every pool reallocation. Note that with overgrow enabled it is possible for the pool to grow beyond this capacity. If set to zero the pool will only allocate a Growable on an explicit allocation request.

pub fn build(&self) -> GrowablePool

Creates a new GrowablePool using this builder.

Trait Implementations

impl Eq for GrowablePoolBuilder

impl PartialEq<GrowablePoolBuilder> for GrowablePoolBuilder

fn eq(&self, other: &GrowablePoolBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Default for GrowablePoolBuilder

fn default() -> Self

Returns the "default value" for a type.

impl Clone for GrowablePoolBuilder

fn clone(&self) -> GrowablePoolBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GrowablePoolBuilder

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

Formats the value using the given formatter.