summary refs log tree commit diff stats
path: root/src/vm.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/vm.rs')
-rw-r--r--src/vm.rs9
1 files changed, 8 insertions, 1 deletions
diff --git a/src/vm.rs b/src/vm.rs
index 6bcbf70..ac5c95d 100644
--- a/src/vm.rs
+++ b/src/vm.rs
@@ -1,17 +1,24 @@
 // Copyright (C) 2021-2022 Soni L.
 // SPDX-License-Identifier: MIT OR Apache-2.0
 
+//! The Datafu Virtual Machine.
+//!
+//! This is the stuff that actually matches the pattern.
+
 use regex::Regex;
 use serde::Serialize;
 
 use crate::Predicate;
 //use crate::errors::MatchError;
 
+mod de;
+
+/// Max depth for VM/serde recursion.
 pub(crate) const MAX_CALLS: usize = 250;
 
 //type Matches<'a, 'b, T> = BTreeMap<&'a str, KVPair<'b, T>>;
 
-// TODO: use a builder for this?
+// maybe we should use a builder for this?
 /// The constant pool for a pattern.
 pub(crate) struct PatternConstants<O: Serialize> {
     // last proto is implicitly the whole pattern.