Skip to content

Commit 7574029

Browse files
committed
Added some notes on naming of functions in reader.rs
1 parent ae849f7 commit 7574029

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

src/reader.rs

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,23 @@ use crate::value::{ToValue, Value};
3030
use std::rc::Rc;
3131

3232
use std::fs::File;
33+
//
34+
// Note; the difference between ours 'parsers'
35+
// identifier_parser
36+
// symbol_parser
37+
// integer_parser
38+
// And our 'try readers'
39+
// try_read_i32
40+
// try_read_string
41+
// try_read_map
42+
// try_read_list
43+
// try_read_vector
44+
//
45+
// Is our parsers are meant to be be nom parsers, and more primitive in that
46+
// they can parse any information that we can later use to create a value::Value
47+
//
48+
// Our 'try readers' are a bit higher level, and are specifically supposed to be returning a valid // value::Value or some sort of failure.
49+
//
3350

3451
/// Parses valid Clojure identifiers
3552
/// Example Successes: ab, cat, -12+3, |blah|, <well>

0 commit comments

Comments
 (0)