feat: add doc strings getter to FullABIFunction

FuelLabs · May 24, 2024 · 857534d · 857534d
1 parent c80a52c
commit 857534d
Showing 1 changed file with 20 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,25 @@ impl FullABIFunction {
         self.attributes.iter().any(|attr| attr.name == "payable")
     }
 
+    pub fn doc_strings(&self) -> Result<Vec<String>> {
+        self.attributes
+            .iter()
+            .filter_map(|attr| {
+                if attr.name == "doc-comment" {
+                    let doc = <[String; 1]>::try_from(attr.arguments.clone())
+                        .map(|[doc]| doc)
+                        .map_err(|_| {
+                            Error("`doc-comment` attribute has more then one argument".to_string())
+                        });
+
+                    Some(doc)
+                } else {
+                    None
+                }
+            })
+            .collect::<Result<Vec<String>>>()
+    }
+
     pub fn from_counterpart(
         abi_function: &ABIFunction,
         types: &HashMap<usize, TypeDeclaration>,