Merge pull request tree-sitter#2423 from amaanq/nonzero-field-id

feat!: use `Option<NonZeroU16>` for TSFieldIds

Author: amaanq

cli/src/tests/parser_test.rs

@@ -665,7 +665,7 @@ fn test_parsing_with_a_timeout() {
     assert!(start_time.elapsed().as_micros() < 2000);
 
     #[cfg(target_arch = "sparc64")]
-    assert!(start_time.elapsed().as_micros() < 4000);
+    assert!(start_time.elapsed().as_micros() < 8000);
 
     // Continue parsing, but pause after 1 ms of processing.
     parser.set_timeout_micros(5000);

lib/binding_rust/lib.rs

@@ -10,6 +10,7 @@ use std::{
     fmt, hash, iter,
     marker::PhantomData,
     mem::MaybeUninit,
+    num::NonZeroU16,
     ops,
     os::raw::{c_char, c_void},
     ptr::{self, NonNull},
@@ -93,6 +94,8 @@ pub enum LogType {
     Lex,
 }
 
+type FieldId = NonZeroU16;
+
 /// A callback that receives log messages during parser.
 type Logger<'a> = Box<dyn FnMut(LogType, &str) + 'a>;
 
@@ -319,7 +322,7 @@ impl Language {
 
     /// Get the numerical id for the given field name.
     #[doc(alias = "ts_language_field_id_for_name")]
-    pub fn field_id_for_name(&self, field_name: impl AsRef<[u8]>) -> Option<u16> {
+    pub fn field_id_for_name(&self, field_name: impl AsRef<[u8]>) -> Option<FieldId> {
         let field_name = field_name.as_ref();
         let id = unsafe {
             ffi::ts_language_field_id_for_name(
@@ -331,7 +334,7 @@ impl Language {
         if id == 0 {
             None
         } else {
-            Some(id)
+            Some(FieldId::new(id).unwrap())
         }
     }
 }
@@ -1060,23 +1063,23 @@ impl<'tree> Node<'tree> {
         cursor: &'a mut TreeCursor<'tree>,
     ) -> impl Iterator<Item = Node<'tree>> + 'a {
         let field_id = self.language().field_id_for_name(field_name);
-        self.children_by_field_id(field_id.unwrap_or(0), cursor)
+        self.children_by_field_id(field_id, cursor)
     }
 
     /// Iterate over this node's children with a given field id.
     ///
     /// See also [Node::children_by_field_name].
     pub fn children_by_field_id<'a>(
         &self,
-        field_id: u16,
+        field_id: Option<FieldId>,
         cursor: &'a mut TreeCursor<'tree>,
     ) -> impl Iterator<Item = Node<'tree>> + 'a {
         cursor.reset(*self);
         cursor.goto_first_child();
         let mut done = false;
         iter::from_fn(move || {
             while !done {
-                while cursor.field_id() != Some(field_id) {
+                while cursor.field_id() != field_id {
                     if !cursor.goto_next_sibling() {
                         return None;
                     }
@@ -1242,13 +1245,13 @@ impl<'a> TreeCursor<'a> {
     ///
     /// See also [field_name](TreeCursor::field_name).
     #[doc(alias = "ts_tree_cursor_current_field_id")]
-    pub fn field_id(&self) -> Option<u16> {
+    pub fn field_id(&self) -> Option<FieldId> {
         unsafe {
             let id = ffi::ts_tree_cursor_current_field_id(&self.0);
             if id == 0 {
                 None
             } else {
-                Some(id)
+                Some(FieldId::new(id).unwrap())
             }
         }
     }