Share tree display extractor utility

Signed-off-by: Joe Isaacs <joe.isaacs@live.co.uk>

Author: joseph-isaacs

vortex-array/src/display/extractor.rs

@@ -1,10 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: Copyright the Vortex contributors
 
-use std::fmt;
-
 pub use vortex_utils::tree::IndentedFormatter;
 use vortex_utils::tree::TreeDisplayContext;
+pub use vortex_utils::tree::TreeDisplayExtractor as TreeExtractor;
 
 use crate::ArrayRef;
 use crate::arrays::Chunked;
@@ -44,37 +43,3 @@ impl TreeDisplayContext<ArrayRef> for TreeContext {
         self.ancestor_sizes.pop();
     }
 }
-
-/// Trait for contributing display information to tree nodes.
-///
-/// Each extractor represents one "dimension" of display (e.g., nbytes, stats, metadata, buffers).
-/// Extractors are composable: you can combine any number of them via [`TreeDisplay::with`].
-///
-/// [`TreeDisplay::with`]: super::TreeDisplay::with
-pub trait TreeExtractor: Send + Sync {
-    /// Write header annotations (space-prefixed) to the formatter.
-    fn write_header(
-        &self,
-        array: &ArrayRef,
-        ctx: &TreeContext,
-        f: &mut fmt::Formatter<'_>,
-    ) -> fmt::Result {
-        let _ = (array, ctx, f);
-        Ok(())
-    }
-
-    /// Write detail lines below the header.
-    ///
-    /// Content written through `f` is automatically indented. Use
-    /// [`f.formatter()`](IndentedFormatter::formatter) to access the underlying
-    /// [`fmt::Formatter`] for formatting flags.
-    fn write_details(
-        &self,
-        array: &ArrayRef,
-        ctx: &TreeContext,
-        f: &mut IndentedFormatter<'_, '_>,
-    ) -> fmt::Result {
-        let _ = (array, ctx, f);
-        Ok(())
-    }
-}

vortex-array/src/display/extractors/buffer.rs

@@ -17,7 +17,7 @@ pub struct BufferExtractor {
     pub show_percent: bool,
 }
 
-impl TreeExtractor for BufferExtractor {
+impl TreeExtractor<ArrayRef, TreeContext> for BufferExtractor {
     fn write_details(
         &self,
         array: &ArrayRef,

vortex-array/src/display/extractors/encoding_summary.rs

@@ -23,7 +23,7 @@ impl EncodingSummaryExtractor {
     }
 }
 
-impl TreeExtractor for EncodingSummaryExtractor {
+impl TreeExtractor<ArrayRef, TreeContext> for EncodingSummaryExtractor {
     fn write_header(
         &self,
         array: &ArrayRef,

vortex-array/src/display/extractors/metadata.rs

@@ -11,7 +11,7 @@ use crate::display::extractor::TreeExtractor;
 /// Extractor that adds a `metadata: ...` detail line.
 pub struct MetadataExtractor;
 
-impl TreeExtractor for MetadataExtractor {
+impl TreeExtractor<ArrayRef, TreeContext> for MetadataExtractor {
     fn write_details(
         &self,
         array: &ArrayRef,

vortex-array/src/display/extractors/nbytes.rs

@@ -13,7 +13,7 @@ use crate::display::extractor::TreeExtractor;
 /// Extractor that adds `nbytes=X (Y%)` to the header line.
 pub struct NbytesExtractor;
 
-impl TreeExtractor for NbytesExtractor {
+impl TreeExtractor<ArrayRef, TreeContext> for NbytesExtractor {
     fn write_header(
         &self,
         array: &ArrayRef,

vortex-array/src/display/extractors/stats.rs

@@ -116,7 +116,7 @@ impl fmt::Display for StatsDisplay<'_> {
 /// Extractor that adds stats annotations (e.g. `[nulls=3, min=5]`) to the header line.
 pub struct StatsExtractor;
 
-impl TreeExtractor for StatsExtractor {
+impl TreeExtractor<ArrayRef, TreeContext> for StatsExtractor {
     fn write_header(
         &self,
         array: &ArrayRef,

vortex-array/src/display/mod.rs

@@ -556,7 +556,7 @@ impl ArrayRef {
                 metadata,
                 stats,
             } => {
-                let extractors: [(bool, Box<dyn TreeExtractor>); 5] = [
+                let extractors: [(bool, Box<dyn TreeExtractor<ArrayRef, TreeContext>>); 5] = [
                     (true, Box::new(EncodingSummaryExtractor)),
                     (*stats, Box::new(NbytesExtractor)),
                     (*stats, Box::new(StatsExtractor)),

vortex-array/src/display/tree_display.rs

@@ -39,7 +39,7 @@ use crate::display::extractors::StatsExtractor;
 /// ```
 pub struct TreeDisplay {
     array: ArrayRef,
-    extractors: Vec<Box<dyn TreeExtractor>>,
+    extractors: Vec<Box<dyn TreeExtractor<ArrayRef, TreeContext>>>,
 }
 
 impl TreeDisplay {
@@ -66,13 +66,13 @@ impl TreeDisplay {
     }
 
     /// Add an extractor to the display pipeline.
-    pub fn with<E: TreeExtractor + 'static>(mut self, extractor: E) -> Self {
+    pub fn with<E: TreeExtractor<ArrayRef, TreeContext> + 'static>(mut self, extractor: E) -> Self {
         self.extractors.push(Box::new(extractor));
         self
     }
 
     /// Add a pre-boxed extractor to the display pipeline.
-    pub fn with_boxed(mut self, extractor: Box<dyn TreeExtractor>) -> Self {
+    pub fn with_boxed(mut self, extractor: Box<dyn TreeExtractor<ArrayRef, TreeContext>>) -> Self {
         self.extractors.push(extractor);
         self
     }

vortex-btrblocks/tests/golden.rs

@@ -65,7 +65,7 @@ const N: usize = 16_384;
 /// [`NbytesExtractor`]: vortex_array::display::NbytesExtractor
 struct ExactNbytesExtractor;
 
-impl TreeExtractor for ExactNbytesExtractor {
+impl TreeExtractor<ArrayRef, TreeContext> for ExactNbytesExtractor {
     fn write_header(
         &self,
         array: &ArrayRef,

vortex-utils/src/tree.rs

@@ -74,6 +74,31 @@ impl<'a, 'b> IndentedFormatter<'a, 'b> {
     }
 }
 
+/// Contributes one composable dimension of information to tree nodes.
+pub trait TreeDisplayExtractor<N: ?Sized, C: TreeDisplayContext<N>>: Send + Sync {
+    /// Write space-prefixed annotations on the node's header line.
+    fn write_header(
+        &self,
+        node: &N,
+        context: &C,
+        formatter: &mut fmt::Formatter<'_>,
+    ) -> fmt::Result {
+        _ = (node, context, formatter);
+        Ok(())
+    }
+
+    /// Write detail lines beneath the node's header.
+    fn write_details(
+        &self,
+        node: &N,
+        context: &C,
+        formatter: &mut IndentedFormatter<'_, '_>,
+    ) -> fmt::Result {
+        _ = (node, context, formatter);
+        Ok(())
+    }
+}
+
 /// Adapts a domain-specific node and traversal context to the shared tree renderers.
 pub trait TreeDisplayAdapter {
     /// Node type traversed by this adapter.