Struct Term 

pub struct Term<PT: ProtocolTypes> {
    pub term: DYTerm<PT>,
    pub payloads: Option<Payloads>,
}

Terms are Terms equipped with optional Payloads when they no longer are treated as symbolic terms.

Fields

term: DYTerm<PT>

payloads: Option<Payloads>

Implementations

impl<PT: ProtocolTypes> Term<PT>

pub(crate) fn eval_until_opaque<PB>( &self, eval_tree: &mut EvalTree, ctx: &TraceContext<PB>, with_payloads: bool, sibling_has_payloads: bool, type_term: &TypeShape<PT>, ) -> Result<(Box<dyn EvaluatedTerm<PT>>, Vec<PayloadContext<'_, PT>>), Error>

where PB: ProtocolBehavior<ProtocolTypes = PT>,

Evaluate a term without replacing the payloads (returning the payloads with the corresponding paths instead, i.e., a Vec<PayloadContext> accumulator), except when reaching an opaque term with payloads as strict sub-terms. In the latter case, fully evaluate each of the arguments (and performing the payload replacements) before evaluating the opaque function, which then needs to be read to convert it back to a Box<dyn EvaluatedTerm<PT>>. @path: current path of &self in the overall recipe (initially []). Invariant: Returns the payloads to replace in this order: deeper first, left-most arguments first. When with_payloads is false, then this should be equivalent to evaluate_lazy_test and it always return empty PayloadContext vectors.

impl<PT: ProtocolTypes> Term<PT>

pub fn height(&self) -> usize

Height of term, considering non-symbolic terms as atoms

pub fn is_list(&self) -> bool

When the term starts with a list function symbol

pub fn is_opaque(&self) -> bool

When the term starts with an opaque function symbol (like encryption)

pub fn is_get(&self) -> bool

When the term starts with an opaque function symbol (like encryption)

pub fn is_no_bit(&self) -> bool

When the term starts with a no_bit function symbol. We will never MakeMessage on, thus disabling applying any of the bit-level mutations.

pub fn is_no_det(&self) -> bool

When the term starts with a no_det function symbol.

pub fn has_variable(&self) -> bool

When the term has a variable as sub-term (excluding strict-sub-terms of readable)

pub fn has_no_det(&self) -> bool

When the term has a non-det sub-term (excluding strict-sub-terms of readable)

pub fn is_readable(&self) -> bool

Whether the term is readable, i.e. whether it has a payload that will be read before evaluating

pub fn erase_payloads_subterms(&mut self, is_subterm: bool)

Erase all payloads in a term, including those under opaque function symbol

pub fn add_payload_with_new( &mut self, payload_0: Vec<u8>, payload_new: Vec<u8>, with_metadata: Option<PayloadMetadata>, )

Add a payload at the root position and start with a new payload.payload possibly different from payload.payload_0, erase payloads in strict sub-terms not under opaque

pub fn add_payload(&mut self, payload_0: Vec<u8>)

Add a payload at the root position, erase payloads in strict sub-terms not under opaque

pub fn make_payload<PB>(&mut self, ctx: &TraceContext<PB>) -> Result<(), Error>

where PB: ProtocolBehavior<ProtocolTypes = PT>,

Make and Add a payload at the root position, erase payloads in strict sub-terms

pub fn add_payload_readable(&mut self, payload: ConcreteMessage)

Add a payload at the root position, erase payloads in strict sub-terms and make the payload readable.

pub fn all_payloads(&self) -> Vec<&Payloads>

Return all payloads contains in a term, even under opaque terms. Note that we keep the invariant that a non-symbolic term cannot have payloads in strict-subterms, see add_payload/make_payload.

pub fn count_payloads(&self) -> usize

Number of payloads in a term, without allocating (unlike all_payloads().len(), which materialises a Vec via the &Term iterator). Cheap enough for the hot mutation path.

Mirrors the iterator’s traversal exactly so the count equals all_payloads().len(): count this node’s own payload, and recurse into sub-terms only while the node is symbolic (a non-symbolic term keeps the invariant that it has no payloads in its strict sub-terms).

pub fn all_payloads_mut(&mut self) -> Vec<&mut Payloads>

Return all payloads contains in a term (mutable references), even under opaque terms. Note that we keep the invariant that a non-symbolic term cannot have payloads in strict-subterms, see add_payload/make_payload.

pub fn payloads_to_replace(&self) -> Vec<&Payloads>

Return all payloads contained in a term, except those under opaque or readable terms. The deeper the first in the returned vector.

pub fn has_payload_to_replace(&self) -> bool

Return whether there is at least one payload, except those under opaque or readable terms.

pub fn has_payload_to_replace_wo_root(&self) -> bool

Return whether there is at least one payload, except those under opaque terms or readable and at the root.

impl<PT: ProtocolTypes> Term<PT>

fn unique_id(&self, tree_mode: bool, cluster_id: usize) -> String

fn node_attributes( displayable: impl Display, color: &str, shape: &str, ) -> String

fn collect_statements( term: &Self, tree_mode: bool, cluster_id: usize, statements: &mut Vec<String>, )

pub fn dot_subgraph( &self, tree_mode: bool, cluster_id: usize, label: &str, ) -> String

If tree_mode is true then each subgraph is self-contained and does not reference other clusters or nodes outside of this subgraph. Therefore, only trees are generated. If it is false, then graphs are rendered.

impl<PT: ProtocolTypes> Term<PT>

pub fn count_functions_by_name(&self, find_name: &'static str) -> usize

Trait Implementations

impl<PT: Clone + ProtocolTypes> Clone for Term<PT>

fn clone(&self) -> Term<PT>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<PT: Debug + ProtocolTypes> Debug for Term<PT>

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

Formats the value using the given formatter.

impl<'de, PT> Deserialize<'de> for Term<PT>

where PT: ProtocolTypes,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<PT: ProtocolTypes> Display for Term<PT>

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

Formats the value using the given formatter.

impl<PT: ProtocolTypes> From<DYTerm<PT>> for Term<PT>

fn from(term: DYTerm<PT>) -> Self

Converts to this type from the input type.

impl<PT: ProtocolTypes> From<Term<PT>> for DYTerm<PT>

fn from(term: Term<PT>) -> Self

Converts to this type from the input type.

impl<PT: Hash + ProtocolTypes> Hash for Term<PT>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, PT: ProtocolTypes> IntoIterator for &'a Term<PT>

Having the same mutator for &’a mut DYTerm is not possible in Rust:

• https://stackoverflow.com/questions/49057270/is-there-a-way-to-iterate-over-a-mutable-tree-to-get-a-random-node
• https://sachanganesh.com/programming/graph-tree-traversals-in-rust/

type IntoIter = IntoIter<&'a Term<PT>>

Which kind of iterator are we turning this into?

type Item = &'a Term<PT>

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<PT: PartialEq + ProtocolTypes> PartialEq for Term<PT>

fn eq(&self, other: &Term<PT>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<PT> Serialize for Term<PT>

where PT: ProtocolTypes,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<PT: ProtocolTypes> Subterms<PT, Term<PT>> for Vec<Term<PT>>

fn find_subterm_same_shape(&self, term: &Term<PT>) -> Option<&Term<PT>>

Finds a subterm with the same type as term

fn find_subterm<P: Fn(&&Term<PT>) -> bool + Copy>( &self, predicate: P, ) -> Option<&Term<PT>>

Finds a subterm in this vector

fn filter_grand_subterms<P: Fn(&Term<PT>, &Term<PT>) -> bool + Copy>( &self, predicate: P, ) -> Vec<((usize, &Term<PT>), &Term<PT>)>

Finds all grand children/subterms which match the predicate.

A grand subterm is defined as a subterm of a term in self.

Each grand subterm is returned together with its parent and the index of the parent in self.

impl<PT: ProtocolTypes> TermType<PT> for Term<PT>

fn evaluate_config<PB: ProtocolBehavior<ProtocolTypes = PT>>( &self, context: &TraceContext<PB>, with_payloads: bool, ) -> Result<(ConcreteMessage, Box<dyn EvaluatedTerm<PT>>), Error>

Evaluate terms into bitstrings and EvaluatedTerm (considering Payloads)

fn size(&self) -> usize

size of a term, considering non-symbolic terms as atoms

fn resistant_id(&self) -> u32

fn is_leaf(&self) -> bool

fn get_type_shape(&self) -> &TypeShape<PT>

fn name(&self) -> &str

fn mutate(&mut self, other: Self)

fn display_at_depth(&self, depth: usize) -> String

fn is_symbolic(&self) -> bool

fn make_symbolic(&mut self)

fn get(&self, path: &[usize]) -> Result<&Self, Error>

fn evaluate_config_wrap<PB: ProtocolBehavior<ProtocolTypes = PT>>( &self, context: &TraceContext<PB>, with_payloads: bool, ) -> Result<(ConcreteMessage, Box<dyn EvaluatedTerm<PT>>), Error>

Wrap evaluate_config with error stats and logging handling

fn evaluate<PB: ProtocolBehavior<ProtocolTypes = PT>>( &self, ctx: &TraceContext<PB>, ) -> Result<ConcreteMessage, Error>

Evaluate terms into ConcreteMessage (considering Payloads)

fn evaluate_symbolic<PB: ProtocolBehavior<ProtocolTypes = PT>>( &self, ctx: &TraceContext<PB>, ) -> Result<ConcreteMessage, Error>

Evaluate terms into ConcreteMessage considering all sub-terms as symbolic (even those with Payloads)

fn evaluate_dy<PB: ProtocolBehavior<ProtocolTypes = PT>>( &self, ctx: &TraceContext<PB>, ) -> Result<Box<dyn EvaluatedTerm<PT>>, Error>

Evaluate terms into EvaluatedTerm considering all sub-terms as symbolic (even those with Payloads)

impl<PT: Eq + ProtocolTypes> Eq for Term<PT>

impl<PT: ProtocolTypes> StructuralPartialEq for Term<PT>