1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
#![allow(incomplete_features)] #![feature(array_map)] #![feature(maybe_uninit_uninit_array)] #![feature(maybe_uninit_array_assume_init)] #![feature(const_generics)] #![deny(missing_docs)] #![warn(clippy::pedantic)] #![warn(clippy::nursery)] //! Type based parsing library //! //! ``` //! use nommy::{parse, text::*, Parse}; //! //! type Letters = AnyOf1<"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ">; //! //! #[derive(Debug, Parse, PartialEq)] //! #[nommy(prefix = Tag<"struct">)] //! #[nommy(ignore = WhiteSpace)] //! struct StructNamed { //! #[nommy(parser = Letters)] //! name: String, //! //! #[nommy(prefix = Tag<"{">, suffix = Tag<"}">)] //! fields: Vec<NamedField>, //! } //! //! #[derive(Debug, Parse, PartialEq)] //! #[nommy(suffix = Tag<",">)] //! #[nommy(ignore = WhiteSpace)] //! struct NamedField { //! #[nommy(parser = Letters)] //! name: String, //! //! #[nommy(prefix = Tag<":">, parser = Letters)] //! ty: String, //! } //! let input = "struct Foo { //! bar: Abc, //! baz: Xyz, //! }"; //! //! let struct_: StructNamed = parse(input.chars()).unwrap(); //! assert_eq!( //! struct_, //! StructNamed { //! name: "Foo".to_string(), //! fields: vec![ //! NamedField { //! name: "bar".to_string(), //! ty: "Abc".to_string(), //! }, //! NamedField { //! name: "baz".to_string(), //! ty: "Xyz".to_string(), //! }, //! ] //! } //! ); //! ``` mod buffer; pub use buffer::*; pub mod bytes; mod impls; pub mod text; use eyre::Context; pub use impls::Vec1; /// Derive Parse for structs or enums /// /// ``` /// use nommy::{parse, text::*, Parse}; /// /// type Letters = AnyOf1<"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ">; /// /// #[derive(Debug, Parse, PartialEq)] /// #[nommy(prefix = Tag<"struct">)] /// #[nommy(ignore = WhiteSpace)] /// struct StructNamed { /// #[nommy(parser = Letters)] /// name: String, /// /// #[nommy(prefix = Tag<"{">, suffix = Tag<"}">)] /// fields: Vec<NamedField>, /// } /// /// #[derive(Debug, Parse, PartialEq)] /// #[nommy(suffix = Tag<",">)] /// #[nommy(ignore = WhiteSpace)] /// struct NamedField { /// #[nommy(parser = Letters)] /// name: String, /// /// #[nommy(prefix = Tag<":">, parser = Letters)] /// ty: String, /// } /// let input = "struct Foo { /// bar: Abc, /// baz: Xyz, /// }"; /// /// let struct_: StructNamed = parse(input.chars()).unwrap(); /// assert_eq!( /// struct_, /// StructNamed { /// name: "Foo".to_string(), /// fields: vec![ /// NamedField { /// name: "bar".to_string(), /// ty: "Abc".to_string(), /// }, /// NamedField { /// name: "baz".to_string(), /// ty: "Xyz".to_string(), /// }, /// ] /// } /// ); /// ``` pub use nommy_derive::Parse; pub use eyre; /// `parse` takes the given iterator, putting it through [`P::parse`](Parse::parse) /// /// ``` /// use nommy::{parse, text::Tag}; /// let dot: Tag<"."> = parse(".".chars()).unwrap(); /// ``` /// /// # Errors /// If `P` failed to parse the input at any point, that error will /// be propagated up the chain. pub fn parse<P, I>(iter: I) -> eyre::Result<P> where P: Parse<<I::Iter as Iterator>::Item>, I: IntoBuf, <I::Iter as Iterator>::Item: Clone, { let mut buffer = iter.into_buf(); P::parse(&mut buffer) } /// `parse_terminated` takes the given iterator, putting it through [`P::parse`](Parse::parse), /// erroring if the full input was not consumed /// /// ``` /// use nommy::{parse_terminated, text::Tag}; /// let res: Result<Tag<".">, _> = parse_terminated(".".chars()); /// res.unwrap(); /// let res: Result<Tag<".">, _> = parse_terminated("..".chars()); /// res.unwrap_err(); /// ``` /// /// # Errors /// If `P` failed to parse the input at any point, that error will /// be propagated up the chain. /// /// Will also error if the input is not empty after parsing pub fn parse_terminated<P, I>(iter: I) -> eyre::Result<P> where P: Parse<<I::Iter as Iterator>::Item>, I: IntoBuf, <I::Iter as Iterator>::Item: Clone, { let mut buffer = iter.into_buf(); let output = P::parse(&mut buffer)?; if buffer.next().is_some() { Err(eyre::eyre!("input was not parsed completely")) } else { Ok(output) } } /// An interface for creating and composing parsers /// Takes in a [`Buffer`] iterator and consumes a subset of it, /// Returning Self if it managed to parse ok, otherwise returning a meaningful error /// Parse can be derived for some types /// /// ``` /// use nommy::{Parse, IntoBuf, text::Tag}; /// let mut buffer = ".".chars().into_buf(); /// Tag::<".">::parse(&mut buffer).unwrap(); /// ``` pub trait Parse<T>: Sized { /// Parse the input buffer, returning Ok if the value could be parsed, /// Otherwise, returns a meaningful error /// /// # Errors /// Will return an error if the parser fails to interpret the input at any point fn parse(input: &mut impl Buffer<T>) -> eyre::Result<Self>; /// Peek reads the input buffer, returning true if the value could be found, /// Otherwise, returns false. /// Not required, but usually provides better performance if implemented fn peek(input: &mut impl Buffer<T>) -> bool { Self::parse(input).is_ok() } }