pub struct Node { /* private fields */ }
Expand description
A node in the operator tree.
The operator tree is created by the crate-level build_operator_tree
method.
It can be evaluated for a given context with the Node::eval
method.
The advantage of constructing the operator tree separately from the actual evaluation is that it can be evaluated arbitrarily often with different contexts.
Examples
use evalexpr::*;
let mut context = HashMapContext::new();
context.set_value("alpha".into(), 2.into()).unwrap(); // Do proper error handling here
let node = build_operator_tree("1 + alpha").unwrap(); // Do proper error handling here
assert_eq!(node.eval_with_context(&context), Ok(Value::from(3)));
Implementations
sourceimpl Node
impl Node
sourcepub fn iter_identifiers(&self) -> impl Iterator<Item = &str>
pub fn iter_identifiers(&self) -> impl Iterator<Item = &str>
Returns an iterator over all identifiers in this expression. Each occurrence of an identifier is returned separately.
Examples
use evalexpr::*;
let tree = build_operator_tree("a + b + c * f()").unwrap(); // Do proper error handling here
let mut iter = tree.iter_identifiers();
assert_eq!(iter.next(), Some("a"));
assert_eq!(iter.next(), Some("b"));
assert_eq!(iter.next(), Some("c"));
assert_eq!(iter.next(), Some("f"));
assert_eq!(iter.next(), None);
sourcepub fn iter_variable_identifiers(&self) -> impl Iterator<Item = &str>
pub fn iter_variable_identifiers(&self) -> impl Iterator<Item = &str>
Returns an iterator over all variable identifiers in this expression. Each occurrence of a variable identifier is returned separately.
Examples
use evalexpr::*;
let tree = build_operator_tree("a + f(b + c)").unwrap(); // Do proper error handling here
let mut iter = tree.iter_variable_identifiers();
assert_eq!(iter.next(), Some("a"));
assert_eq!(iter.next(), Some("b"));
assert_eq!(iter.next(), Some("c"));
assert_eq!(iter.next(), None);
sourcepub fn iter_function_identifiers(&self) -> impl Iterator<Item = &str>
pub fn iter_function_identifiers(&self) -> impl Iterator<Item = &str>
Returns an iterator over all function identifiers in this expression. Each occurrence of a function identifier is returned separately.
Examples
use evalexpr::*;
let tree = build_operator_tree("a + f(b + c)").unwrap(); // Do proper error handling here
let mut iter = tree.iter_function_identifiers();
assert_eq!(iter.next(), Some("f"));
assert_eq!(iter.next(), None);
sourcepub fn eval_with_context<C: Context>(
&self,
context: &C
) -> EvalexprResult<Value>
pub fn eval_with_context<C: Context>(
&self,
context: &C
) -> EvalexprResult<Value>
Evaluates the operator tree rooted at this node with the given context.
Fails, if one of the operators in the expression tree fails.
sourcepub fn eval_with_context_mut<C: ContextWithMutableVariables>(
&self,
context: &mut C
) -> EvalexprResult<Value>
pub fn eval_with_context_mut<C: ContextWithMutableVariables>(
&self,
context: &mut C
) -> EvalexprResult<Value>
Evaluates the operator tree rooted at this node with the given mutable context.
Fails, if one of the operators in the expression tree fails.
sourcepub fn eval(&self) -> EvalexprResult<Value>
pub fn eval(&self) -> EvalexprResult<Value>
Evaluates the operator tree rooted at this node.
Fails, if one of the operators in the expression tree fails.
sourcepub fn eval_string_with_context<C: Context>(
&self,
context: &C
) -> EvalexprResult<String>
pub fn eval_string_with_context<C: Context>(
&self,
context: &C
) -> EvalexprResult<String>
Evaluates the operator tree rooted at this node into a string with an the given context.
Fails, if one of the operators in the expression tree fails.
sourcepub fn eval_float_with_context<C: Context>(
&self,
context: &C
) -> EvalexprResult<FloatType>
pub fn eval_float_with_context<C: Context>(
&self,
context: &C
) -> EvalexprResult<FloatType>
Evaluates the operator tree rooted at this node into a float with an the given context.
Fails, if one of the operators in the expression tree fails.
sourcepub fn eval_int_with_context<C: Context>(
&self,
context: &C
) -> EvalexprResult<IntType>
pub fn eval_int_with_context<C: Context>(
&self,
context: &C
) -> EvalexprResult<IntType>
Evaluates the operator tree rooted at this node into an integer with an the given context.
Fails, if one of the operators in the expression tree fails.
sourcepub fn eval_number_with_context<C: Context>(
&self,
context: &C
) -> EvalexprResult<FloatType>
pub fn eval_number_with_context<C: Context>(
&self,
context: &C
) -> EvalexprResult<FloatType>
Evaluates the operator tree rooted at this node into a float with an the given context. If the result of the expression is an integer, it is silently converted into a float.
Fails, if one of the operators in the expression tree fails.
sourcepub fn eval_boolean_with_context<C: Context>(
&self,
context: &C
) -> EvalexprResult<bool>
pub fn eval_boolean_with_context<C: Context>(
&self,
context: &C
) -> EvalexprResult<bool>
Evaluates the operator tree rooted at this node into a boolean with an the given context.
Fails, if one of the operators in the expression tree fails.
sourcepub fn eval_tuple_with_context<C: Context>(
&self,
context: &C
) -> EvalexprResult<TupleType>
pub fn eval_tuple_with_context<C: Context>(
&self,
context: &C
) -> EvalexprResult<TupleType>
Evaluates the operator tree rooted at this node into a tuple with an the given context.
Fails, if one of the operators in the expression tree fails.
sourcepub fn eval_empty_with_context<C: Context>(
&self,
context: &C
) -> EvalexprResult<EmptyType>
pub fn eval_empty_with_context<C: Context>(
&self,
context: &C
) -> EvalexprResult<EmptyType>
Evaluates the operator tree rooted at this node into an empty value with an the given context.
Fails, if one of the operators in the expression tree fails.
sourcepub fn eval_string_with_context_mut<C: ContextWithMutableVariables>(
&self,
context: &mut C
) -> EvalexprResult<String>
pub fn eval_string_with_context_mut<C: ContextWithMutableVariables>(
&self,
context: &mut C
) -> EvalexprResult<String>
Evaluates the operator tree rooted at this node into a string with an the given mutable context.
Fails, if one of the operators in the expression tree fails.
sourcepub fn eval_float_with_context_mut<C: ContextWithMutableVariables>(
&self,
context: &mut C
) -> EvalexprResult<FloatType>
pub fn eval_float_with_context_mut<C: ContextWithMutableVariables>(
&self,
context: &mut C
) -> EvalexprResult<FloatType>
Evaluates the operator tree rooted at this node into a float with an the given mutable context.
Fails, if one of the operators in the expression tree fails.
sourcepub fn eval_int_with_context_mut<C: ContextWithMutableVariables>(
&self,
context: &mut C
) -> EvalexprResult<IntType>
pub fn eval_int_with_context_mut<C: ContextWithMutableVariables>(
&self,
context: &mut C
) -> EvalexprResult<IntType>
Evaluates the operator tree rooted at this node into an integer with an the given mutable context.
Fails, if one of the operators in the expression tree fails.
sourcepub fn eval_number_with_context_mut<C: ContextWithMutableVariables>(
&self,
context: &mut C
) -> EvalexprResult<FloatType>
pub fn eval_number_with_context_mut<C: ContextWithMutableVariables>(
&self,
context: &mut C
) -> EvalexprResult<FloatType>
Evaluates the operator tree rooted at this node into a float with an the given mutable context. If the result of the expression is an integer, it is silently converted into a float.
Fails, if one of the operators in the expression tree fails.
sourcepub fn eval_boolean_with_context_mut<C: ContextWithMutableVariables>(
&self,
context: &mut C
) -> EvalexprResult<bool>
pub fn eval_boolean_with_context_mut<C: ContextWithMutableVariables>(
&self,
context: &mut C
) -> EvalexprResult<bool>
Evaluates the operator tree rooted at this node into a boolean with an the given mutable context.
Fails, if one of the operators in the expression tree fails.
sourcepub fn eval_tuple_with_context_mut<C: ContextWithMutableVariables>(
&self,
context: &mut C
) -> EvalexprResult<TupleType>
pub fn eval_tuple_with_context_mut<C: ContextWithMutableVariables>(
&self,
context: &mut C
) -> EvalexprResult<TupleType>
Evaluates the operator tree rooted at this node into a tuple with an the given mutable context.
Fails, if one of the operators in the expression tree fails.
sourcepub fn eval_empty_with_context_mut<C: ContextWithMutableVariables>(
&self,
context: &mut C
) -> EvalexprResult<EmptyType>
pub fn eval_empty_with_context_mut<C: ContextWithMutableVariables>(
&self,
context: &mut C
) -> EvalexprResult<EmptyType>
Evaluates the operator tree rooted at this node into an empty value with an the given mutable context.
Fails, if one of the operators in the expression tree fails.
sourcepub fn eval_string(&self) -> EvalexprResult<String>
pub fn eval_string(&self) -> EvalexprResult<String>
Evaluates the operator tree rooted at this node into a string.
Fails, if one of the operators in the expression tree fails.
sourcepub fn eval_float(&self) -> EvalexprResult<FloatType>
pub fn eval_float(&self) -> EvalexprResult<FloatType>
Evaluates the operator tree rooted at this node into a float.
Fails, if one of the operators in the expression tree fails.
sourcepub fn eval_int(&self) -> EvalexprResult<IntType>
pub fn eval_int(&self) -> EvalexprResult<IntType>
Evaluates the operator tree rooted at this node into an integer.
Fails, if one of the operators in the expression tree fails.
sourcepub fn eval_number(&self) -> EvalexprResult<FloatType>
pub fn eval_number(&self) -> EvalexprResult<FloatType>
Evaluates the operator tree rooted at this node into a float. If the result of the expression is an integer, it is silently converted into a float.
Fails, if one of the operators in the expression tree fails.
sourcepub fn eval_boolean(&self) -> EvalexprResult<bool>
pub fn eval_boolean(&self) -> EvalexprResult<bool>
Evaluates the operator tree rooted at this node into a boolean.
Fails, if one of the operators in the expression tree fails.
sourcepub fn eval_tuple(&self) -> EvalexprResult<TupleType>
pub fn eval_tuple(&self) -> EvalexprResult<TupleType>
Evaluates the operator tree rooted at this node into a tuple.
Fails, if one of the operators in the expression tree fails.
sourcepub fn eval_empty(&self) -> EvalexprResult<EmptyType>
pub fn eval_empty(&self) -> EvalexprResult<EmptyType>
Evaluates the operator tree rooted at this node into an empty value.
Fails, if one of the operators in the expression tree fails.
sourcepub fn children_mut(&mut self) -> &mut Vec<Node>
pub fn children_mut(&mut self) -> &mut Vec<Node>
Returns a mutable reference to the vector containing the children of this node.
WARNING: Writing to this might have unexpected results, as some operators require certain amounts and types of arguments.
sourcepub fn operator_mut(&mut self) -> &mut Operator
pub fn operator_mut(&mut self) -> &mut Operator
Returns a mutable reference to the operator associated with this node.
WARNING: Writing to this might have unexpected results, as some operators require different amounts and types of arguments.
Trait Implementations
impl StructuralPartialEq for Node
Auto Trait Implementations
impl RefUnwindSafe for Node
impl Send for Node
impl Sync for Node
impl Unpin for Node
impl UnwindSafe for Node
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more