fp-macros 0.8.0

Procedural macros for generating and working with Higher-Kinded Type (HKT) traits in the fp-library crate.
Documentation 
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

use {
	crate::{
		core::{
			Result as OurResult,
			constants::attributes::DOCUMENT_RETURNS,
		},
		support::{
			ast::RustAst,
			attributes::reject_duplicate_attribute,
			generate_documentation::{
				find_insertion_index,
				insert_doc_comments_batch,
			},
		},
	},
	proc_macro2::TokenStream,
	quote::quote,
};

/// Worker for the `document_returns` macro.
pub fn document_returns_worker(
	attr: TokenStream,
	item: TokenStream,
) -> OurResult<TokenStream> {
	let description: syn::LitStr = syn::parse2(attr)?;
	let mut ast = RustAst::parse(item).map_err(crate::core::Error::Parse)?;

	reject_duplicate_attribute(ast.attributes(), DOCUMENT_RETURNS)?;

	if ast.signature().is_some() {
		process_document_returns_on_ast(&mut ast, &description);
	} else {
		return Err(syn::Error::new_spanned(
			ast,
			format!("{DOCUMENT_RETURNS} can only be applied to functions"),
		)
		.into());
	}

	Ok(quote!(#ast))
}

fn process_document_returns_on_ast(
	ast: &mut RustAst,
	description: &syn::LitStr,
) {
	let description_value = description.value();
	let docs = vec![
		(String::new(), "### Returns\n".to_string()),
		(String::new(), format!("{description_value}\n")),
	];

	let attrs = ast.attributes();
	let insert_idx = find_insertion_index(attrs, description.span());
	insert_doc_comments_batch(attrs, docs, insert_idx);
}