Struct EventBuilder

pub struct EventBuilder<'atree> { /* private fields */ }

An Event builder

During the builder creation, it will set all the attributes to undefined. If some attributes are not assigned, they will be left undefined.

Implementations

impl<'atree> EventBuilder<'atree>

pub fn build(self) -> Result<Event, EventError>

Build the corresponding Event.

By default, the non-assigned attributes will be undefined.

Examples

use a_tree::{ATree, AttributeDefinition};

let definitions = [
    AttributeDefinition::boolean("private"),
    AttributeDefinition::integer("exchange_id"),
    AttributeDefinition::string_list("deal_ids"),
];
let atree = ATree::<u64>::new(&definitions).unwrap();

let mut builder = atree.make_event();
builder.with_integer("exchange_id", 1).unwrap();
builder.with_boolean("private", false).unwrap();

// The returned `Event` will have its `deal_ids` attribute `undefined` since it was not set
// by the builder
let event = builder.build().unwrap();

pub fn with_boolean( &mut self, name: &str, value: bool, ) -> Result<(), EventError>

Set the specified boolean attribute.

The specified attribute must exist within the crate::ATree and its type must be boolean.

pub fn with_integer(&mut self, name: &str, value: i64) -> Result<(), EventError>

Set the specified integer attribute.

The specified attribute must exist within the crate::ATree and its type must be integer.

pub fn with_float( &mut self, name: &str, number: i64, scale: u32, ) -> Result<(), EventError>

Set the specified float attribute.

The specified attribute must exist within the crate::ATree and its type must be float.

pub fn with_string(&mut self, name: &str, value: &str) -> Result<(), EventError>

Set the specified string attribute.

The specified attribute must exist within the crate::ATree and its type must be string.

pub fn with_integer_list( &mut self, name: &str, value: &[i64], ) -> Result<(), EventError>

Set the specified list of integers attribute.

The specified attribute must exist within the crate::ATree and its type must be a list of integers.

pub fn with_undefined(&mut self, name: &str) -> Result<(), EventError>

Set the specified attribute to undefined.

The specified attribute must exist within the crate::ATree.

pub fn with_string_list( &mut self, name: &str, values: &[&str], ) -> Result<(), EventError>

Set the specified string list attribute.

The specified attribute must exist within the crate::ATree and its type must be a list of strings.

Trait Implementations

impl<'atree> Debug for EventBuilder<'atree>

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

Formats the value using the given formatter.