Struct prodash::TreeOptions

pub struct TreeOptions {
    pub initial_capacity: usize,
    pub message_buffer_capacity: usize,
}

A way to configure new tree::Root instances

use prodash::{Tree, TreeOptions};
let tree = TreeOptions::default().create();
let tree2 = TreeOptions { message_buffer_capacity: 100, ..TreeOptions::default() }.create();

Fields

initial_capacity: usize

The amount of items the tree can hold without being forced to allocate

message_buffer_capacity: usize

The amount of messages we can hold before we start overwriting old ones

Methods

impl TreeOptions

pub fn create(self) -> Tree

Create a new Root instance from the configuration within.

Trait Implementations

impl Clone for TreeOptions

fn clone(&self) -> TreeOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TreeOptions

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

Formats the value using the given formatter.

impl Default for TreeOptions

fn default() -> Self

Returns the "default value" for a type.

impl From<TreeOptions> for Tree

fn from(
    TreeOptions { initial_capacity: initial_capacity, message_buffer_capacity: message_buffer_capacity }: TreeOptions
) -> Self

Performs the conversion.