From 4d5c68e7bb09fae18832e2a453f114df5ba32ce1 Mon Sep 17 00:00:00 2001 From: Timon Vonk Date: Sat, 22 Jun 2024 22:15:49 +0200 Subject: [PATCH] feat(ingestion_node): improved human readable Debug --- swiftide/src/ingestion/ingestion_node.rs | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/swiftide/src/ingestion/ingestion_node.rs b/swiftide/src/ingestion/ingestion_node.rs index 102daf10..d3b3d8e0 100644 --- a/swiftide/src/ingestion/ingestion_node.rs +++ b/swiftide/src/ingestion/ingestion_node.rs @@ -19,6 +19,7 @@ //! need to be processed together. use std::{ collections::HashMap, + fmt::Debug, hash::{Hash, Hasher}, path::PathBuf, }; @@ -30,7 +31,7 @@ use serde::{Deserialize, Serialize}; /// `IngestionNode` encapsulates all necessary information for a single unit of data being processed /// in the ingestion pipeline. It includes fields for an identifier, file path, data chunk, optional /// vector representation, and metadata. -#[derive(Debug, Default, Clone, Serialize, Deserialize, PartialEq)] +#[derive(Default, Clone, Serialize, Deserialize, PartialEq)] pub struct IngestionNode { /// Optional identifier for the node. pub id: Option, @@ -44,6 +45,25 @@ pub struct IngestionNode { pub metadata: HashMap, } +impl Debug for IngestionNode { + /// Formats the node for debugging purposes. + /// + /// This method is used to provide a human-readable representation of the node when debugging. + /// The vector field is displayed as the number of elements in the vector if present. + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.debug_struct("IngestionNode") + .field("id", &self.id) + .field("path", &self.path) + .field("chunk", &self.chunk) + .field("metadata", &self.metadata) + .field( + "vector", + &self.vector.as_ref().map(|v| format!("[{}]", v.len())), + ) + .finish() + } +} + impl IngestionNode { /// Creates a new instance of `IngestionNode` with the specified data chunk. ///