Add must_use attributes to accessor methods

Author: alexcrocha

rust/ruby-rbs/build.rs

@@ -117,6 +117,7 @@ fn write_node_field_accessor(
     rust_type: &str,
 ) -> std::io::Result<()> {
     if field.optional {
+        writeln!(file, "    #[must_use]")?;
         writeln!(
             file,
             "    pub fn {}(&self) -> Option<{rust_type}<'a>> {{",
@@ -136,6 +137,7 @@ fn write_node_field_accessor(
         )?;
         writeln!(file, "        }}")?;
     } else {
+        writeln!(file, "    #[must_use]")?;
         writeln!(
             file,
             "    pub fn {}(&self) -> {rust_type}<'a> {{",
@@ -371,6 +373,7 @@ fn generate(config: &Config) -> Result<(), Box<dyn Error>> {
             for field in fields {
                 match field.c_type.as_str() {
                     "rbs_string" => {
+                        writeln!(file, "    #[must_use]")?;
                         writeln!(file, "    pub fn {}(&self) -> RBSString {{", field.name)?;
                         writeln!(
                             file,
@@ -381,6 +384,7 @@ fn generate(config: &Config) -> Result<(), Box<dyn Error>> {
                         writeln!(file)?;
                     }
                     "bool" => {
+                        writeln!(file, "    #[must_use]")?;
                         writeln!(file, "    pub fn {}(&self) -> bool {{", field.name)?;
                         writeln!(file, "        unsafe {{ (*self.pointer).{} }}", field.name)?;
                         writeln!(file, "    }}")?;
@@ -398,6 +402,7 @@ fn generate(config: &Config) -> Result<(), Box<dyn Error>> {
                     }
                     "rbs_location" => {
                         if field.optional {
+                            writeln!(file, "    #[must_use]")?;
                             writeln!(
                                 file,
                                 "    pub fn {}(&self) -> Option<RBSLocation> {{",
@@ -415,6 +420,7 @@ fn generate(config: &Config) -> Result<(), Box<dyn Error>> {
                             writeln!(file, "        }}")?;
                             writeln!(file, "    }}")?;
                         } else {
+                            writeln!(file, "    #[must_use]")?;
                             writeln!(file, "    pub fn {}(&self) -> RBSLocation {{", field.name)?;
                             writeln!(
                                 file,
@@ -427,6 +433,7 @@ fn generate(config: &Config) -> Result<(), Box<dyn Error>> {
                     }
                     "rbs_location_list" => {
                         if field.optional {
+                            writeln!(file, "    #[must_use]")?;
                             writeln!(
                                 file,
                                 "    pub fn {}(&self) -> Option<RBSLocationList> {{",
@@ -444,6 +451,7 @@ fn generate(config: &Config) -> Result<(), Box<dyn Error>> {
                             writeln!(file, "        }}")?;
                             writeln!(file, "    }}")?;
                         } else {
+                            writeln!(file, "    #[must_use]")?;
                             writeln!(
                                 file,
                                 "    pub fn {}(&self) -> RBSLocationList {{",
@@ -468,6 +476,7 @@ fn generate(config: &Config) -> Result<(), Box<dyn Error>> {
                             field.name.as_str()
                         };
                         if field.optional {
+                            writeln!(file, "    #[must_use]")?;
                             writeln!(file, "    pub fn {name}(&self) -> Option<Node<'a>> {{")?;
                             writeln!(
                                 file,
@@ -479,6 +488,7 @@ fn generate(config: &Config) -> Result<(), Box<dyn Error>> {
                                 "        if ptr.is_null() {{ None }} else {{ Some(Node::new(self.parser, ptr)) }}"
                             )?;
                         } else {
+                            writeln!(file, "    #[must_use]")?;
                             writeln!(file, "    pub fn {name}(&self) -> Node<'a> {{")?;
                             writeln!(
                                 file,

rust/ruby-rbs/src/lib.rs

@@ -55,6 +55,7 @@ impl Drop for SignatureNode<'_> {
 }
 
 impl KeywordNode<'_> {
+    #[must_use]
     pub fn name(&self) -> &[u8] {
         unsafe {
             let constant_ptr = rbs_constant_pool_id_to_constant(
@@ -78,6 +79,7 @@ pub struct NodeList<'a> {
 }
 
 impl<'a> NodeList<'a> {
+    #[must_use]
     pub fn new(parser: NonNull<rbs_parser_t>, pointer: *mut rbs_node_list_t) -> Self {
         Self {
             parser,
@@ -125,6 +127,7 @@ pub struct RBSHash<'a> {
 }
 
 impl<'a> RBSHash<'a> {
+    #[must_use]
     pub fn new(parser: NonNull<rbs_parser_t>, pointer: *mut rbs_hash) -> Self {
         Self {
             parser,
@@ -171,14 +174,17 @@ pub struct RBSLocation {
 }
 
 impl RBSLocation {
+    #[must_use]
     pub fn new(pointer: *const rbs_location_t) -> Self {
         Self { pointer }
     }
 
+    #[must_use]
     pub fn start(&self) -> i32 {
         unsafe { (*self.pointer).rg.start.byte_pos }
     }
 
+    #[must_use]
     pub fn end(&self) -> i32 {
         unsafe { (*self.pointer).rg.end.byte_pos }
     }
@@ -189,6 +195,7 @@ pub struct RBSLocationList {
 }
 
 impl RBSLocationList {
+    #[must_use]
     pub fn new(pointer: *mut rbs_location_list) -> Self {
         Self { pointer }
     }
@@ -227,10 +234,12 @@ pub struct RBSString {
 }
 
 impl RBSString {
+    #[must_use]
     pub fn new(pointer: *const rbs_string_t) -> Self {
         Self { pointer }
     }
 
+    #[must_use]
     pub fn as_bytes(&self) -> &[u8] {
         unsafe {
             let s = *self.pointer;
@@ -240,6 +249,7 @@ impl RBSString {
 }
 
 impl SymbolNode<'_> {
+    #[must_use]
     pub fn name(&self) -> &[u8] {
         unsafe {
             let constant_ptr = rbs_constant_pool_id_to_constant(