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
#![doc(html_root_url = "https://docs.rs/call2-for-syn/2.0.3")] #![forbid(unsafe_code)] #![warn(clippy::pedantic)] use proc_macro2::TokenStream; use std::{ error::Error, fmt::{self, Debug, Display, Formatter}, result::Result as stdResult, }; use syn::parse::{ParseStream, Parser}; #[cfg(doctest)] pub mod readme { doc_comment::doctest!("../README.md"); } /// Analogous to [`syn::parse2`] and [`syn::parse::ParseBuffer::call`]. /// /// This function ignores an underlying check whether input was fully parsed. /// /// # Examples /// /// ```rust /// use call2_for_syn::call2_allow_incomplete; /// use quote::quote; /// use syn::{Ident, Token}; /// /// # (|| { /// let (hello, world) = call2_allow_incomplete(quote!(Hello world!), |input| { /// let hello: Ident = input.parse()?; /// let world: Ident = input.parse()?; /// // input.parse::<Token![!]>()?; /// syn::Result::Ok((hello, world)) /// })?; /// /// assert_eq!(format!("{}", hello), "Hello"); /// assert_eq!(format!("{}", world), "world"); /// # syn::Result::Ok(()) /// # })().unwrap(); /// ``` /// /// ```rust /// use call2_for_syn::call2_allow_incomplete; /// use quote::quote; /// use syn::{Ident, Token}; /// /// # (|| { /// let (hello, world) = call2_allow_incomplete(quote!(Hello world!), |input| { /// let hello: Ident = input.parse()?; /// let world: Ident = input.parse()?; /// input.parse::<Token![!]>()?; /// syn::Result::Ok((hello, world)) /// })?; /// /// assert_eq!(format!("{}", hello), "Hello"); /// assert_eq!(format!("{}", world), "world"); /// # syn::Result::Ok(()) /// # })().unwrap(); /// ``` /// /// [`syn::parse2`]: https://docs.rs/syn/1.0.14/syn/fn.parse2.html /// [`syn::parse::ParseBuffer::call`]: https://docs.rs/syn/1.0.14/syn/parse/struct.ParseBuffer.html#method.call pub fn call2_allow_incomplete<T, P: FnOnce(ParseStream) -> T>(input: TokenStream, parser: P) -> T { let mut result = None; Parser::parse2( |input: ParseStream| { result = Some(parser(input)); Ok(()) }, input, ) .ok(); result.unwrap() } /// Analogous to [`syn::parse2`] and [`syn::parse::ParseBuffer::call`]. /// /// # Errors /// /// Iff not all of `input` is consumed by `parser`. /// `parser`'s result is still returned in the error value, in this case. /// /// # Examples /// /// ```rust /// use call2_for_syn::call2_strict; /// use quote::quote; /// use syn::{Ident, Token}; /// /// # (|| { /// let (hello, world) = call2_strict(quote!(Hello world!), |input| { /// let hello: Ident = input.parse()?; /// let world: Ident = input.parse()?; /// // input.parse::<Token![!]>()?; /// syn::Result::Ok((hello, world)) /// }).unwrap_err().parsed?; /// /// assert_eq!(format!("{}", hello), "Hello"); /// assert_eq!(format!("{}", world), "world"); /// # syn::Result::Ok(()) /// # })().unwrap(); /// ``` /// /// ```rust /// use call2_for_syn::call2_strict; /// use quote::quote; /// use syn::{Ident, Token}; /// /// # (|| { /// let (hello, world) = call2_strict(quote!(Hello world!), |input| { /// let hello: Ident = input.parse()?; /// let world: Ident = input.parse()?; /// input.parse::<Token![!]>()?; /// syn::Result::Ok((hello, world)) /// })??; /// /// assert_eq!(format!("{}", hello), "Hello"); /// assert_eq!(format!("{}", world), "world"); /// # Result::<_, Box<dyn std::error::Error>>::Ok(()) /// # })().unwrap(); /// ``` /// /// [`syn::parse2`]: https://docs.rs/syn/1.0.14/syn/fn.parse2.html /// [`syn::parse::ParseBuffer::call`]: https://docs.rs/syn/1.0.14/syn/parse/struct.ParseBuffer.html#method.call #[rustversion::attr(since(1.46), track_caller)] pub fn call2_strict<T, P: FnOnce(ParseStream) -> T>( input: TokenStream, parser: P, ) -> stdResult<T, Incomplete<T>> { let mut parsed = None; match Parser::parse2( |input: ParseStream| { parsed = Some(parser(input)); Ok(()) }, input, ) { Ok(()) => Ok(parsed.unwrap()), Err(syn_error) => Err(Incomplete { parsed: parsed.unwrap(), syn_error, }), } } /// Returned by [`call2_strict`]. /// /// [`call2_strict`]: ./fn.call2_strict.html pub type Result<T> = stdResult<T, Incomplete<T>>; /// Signifies that `parser` did not consume all of `input` in a [`call2_strict`] call. /// /// [`call2_strict`]: ./fn.call2_strict.html #[derive(Debug, Clone)] pub struct Incomplete<T> { pub parsed: T, pub syn_error: syn::Error, } impl<T: Debug> Error for Incomplete<T> { fn source(&self) -> Option<&(dyn Error + 'static)> { Some(&self.syn_error) } } impl<T> Display for Incomplete<T> { fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { write!(f, "TokenStream parsed incompleteley") } }