Struct ATree

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

The A-Tree data structure as described by the paper

See the module documentation for more details.

Implementations

impl<T: Eq + Hash + Clone + Debug> ATree<T>

pub fn new(definitions: &[AttributeDefinition]) -> Result<Self, ATreeError<'_>>

Create a new ATree with the attributes that can be used by the inserted arbitrary boolean expressions along with their types.

Examples

use a_tree::{ATree, AttributeDefinition};

let definitions = [
    AttributeDefinition::boolean("private"),
    AttributeDefinition::integer("exchange_id")
];
let result = ATree::<u64>::new(&definitions);
assert!(result.is_ok());

Duplicate attributes are not allowed and the ATree::new() function will return an error if there are some:

use a_tree::{ATree, AttributeDefinition};

let definitions = [
    AttributeDefinition::boolean("private"),
    AttributeDefinition::boolean("private"),
];
let result = ATree::<u64>::new(&definitions);
assert!(result.is_err());

pub fn insert<'a>( &'a mut self, subscription_id: &T, expression: &'a str, ) -> Result<(), ATreeError<'a>>

Insert an arbitrary boolean expression inside the ATree.

Examples

use a_tree::{ATree, AttributeDefinition};

let definitions = [
    AttributeDefinition::boolean("private"),
    AttributeDefinition::integer("exchange_id")
];
let mut atree = ATree::new(&definitions).unwrap();
assert!(atree.insert(&1u64, "exchange_id = 5").is_ok());
assert!(atree.insert(&2u64, "private").is_ok());

pub fn make_event(&self) -> EventBuilder<'_>

Create a new EventBuilder to be able to generate an Event that will be usable for finding the matching arbitrary boolean expressions inside the ATree via the ATree::search() function.

pub fn search(&self, event: &Event) -> Result<Report<'_, T>, ATreeError<'_>>

Search the ATree for arbitrary boolean expressions that match the Event.

pub fn delete(&mut self, subscription_id: &T)

Delete the specified expression

pub fn to_graphviz(&self) -> String

Export the ATree to the Graphviz format.

Trait Implementations

impl<T: Clone> Clone for ATree<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ATree<T>

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

Formats the value using the given formatter.