Add DataType::is_nested() (#2707)

* Add DataType::is_nested() * Fix documentation for is_nested Co-authored-by: Liang-Chi Hsieh <viirya@gmail.com> Co-authored-by: Liang-Chi Hsieh <viirya@gmail.com>
apache · Sep 12, 2022 · 0ba5c5b · 0ba5c5b
1 parent be33fb3
commit 0ba5c5b
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/arrow/src/datatypes/datatype.rs b/arrow/src/datatypes/datatype.rs
@@ -1439,6 +1439,20 @@ impl DataType {
         )
     }
 
+    /// Returns true if this type is nested (List, FixedSizeList, LargeList, Struct, Union, or Map)
+    pub fn is_nested(t: &DataType) -> bool {
+        use DataType::*;
+        matches!(
+            t,
+            List(_)
+                | FixedSizeList(_, _)
+                | LargeList(_)
+                | Struct(_)
+                | Union(_, _, _)
+                | Map(_, _)
+        )
+    }
+
     /// Compares the datatype with another, ignoring nested field names
     /// and metadata.
     pub fn equals_datatype(&self, other: &DataType) -> bool {