Struct flashmap::Builder

pub struct Builder<S = RandomState> { /* private fields */ }

A builder for a map.

This builder allows you to specify an initial capacity and a hasher, and provides more flexibility in how that hasher can be constructed.

Implementations

impl Builder<RandomState>

pub fn new() -> Self

Creates a new builder with a RandomState hasher, and an initial capacity of zero.

impl<S> Builder<S>

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

Sets the initial capacity of the map. If not specified, the default is 0.

pub unsafe fn with_hasher<H>(self, hasher: H) -> Builder<H> where
    H: Clone + BuildHasher, 

Sets the hasher for the underlying map. The provided hasher must implement Clone due to the implementation details of this crate.

Safety

See crate::with_hasher.

pub unsafe fn with_hasher_generator<H>(self, gen: fn() -> H) -> Builder<H> where
    H: BuildHasher, 

Sets the hasher for the underlying map. Similar to with_hasher, but instead of using a concrete hasher builder, the provided function will be called as many times as necessary to initialize the underlying map.

Safety

See crate::with_hasher.

pub fn build<K, V>(self) -> (WriteHandle<K, V, S>, ReadHandle<K, V, S>) where
    K: TrustedHashEq,
    S: BuildHasher, 

Consumes the builder and returns a write handle and read handle to the map.

Examples

// Use type inference to determine the key and value types
let (mut write, read) = Builder::new().build();

write.guard().insert(10u32, 20u32);

// Or specify them explicitly
let (write, read) = Builder::new().build::<String, String>();

pub unsafe fn build_assert_trusted<K, V>(
    self
) -> (WriteHandle<K, V, S>, ReadHandle<K, V, S>) where
    K: Hash + Eq,
    S: BuildHasher, 

Consumes the builder and returns a write handle and read handle to the map.

Safety

The implementations of Hash and Eq for the key type must be deterministic. See TrustedHashEq for details.

Trait Implementations

impl<S: Clone> Clone for Builder<S>

fn clone(&self) -> Builder<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Debug for Builder<S>

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

Formats the value using the given formatter.

impl Default for Builder<RandomState>

fn default() -> Self

Returns the “default value” for a type.

impl<S: Copy> Copy for Builder<S>