feat: add doc strings getter to FullABIFunction (#21)

FuelLabs · May 27, 2024 · 8ab2888 · 8ab2888
1 parent c80a52c
commit 8ab2888
Showing 1 changed file with 15 additions and 1 deletion.
diff --git a/src/abi/full_program.rs b/src/abi/full_program.rs
@@ -9,7 +9,7 @@ use crate::{
 };
 
 use crate::{
-    error::{error, Result},
+    error::{error, Error, Result},
     utils::TypePath,
 };
 
@@ -121,6 +121,20 @@ impl FullABIFunction {
         self.attributes.iter().any(|attr| attr.name == "payable")
     }
 
+    pub fn doc_strings(&self) -> Result<Vec<String>> {
+        self.attributes
+            .iter()
+            .filter(|attr| attr.name == "doc-comment")
+            .map(|attr| {
+                (attr.arguments.len() == 1)
+                    .then_some(attr.arguments[0].clone())
+                    .ok_or_else(|| {
+                        Error("`doc-comment` attribute must have one argument".to_string())
+                    })
+            })
+            .collect::<Result<Vec<String>>>()
+    }
+
     pub fn from_counterpart(
         abi_function: &ABIFunction,
         types: &HashMap<usize, TypeDeclaration>,