Show Mat data dump in Debug implementation

Author: twistedfall

binding-generator/src/class/desc.rs

@@ -1,8 +1,7 @@
 use std::rc::Rc;
 
-use crate::element::ExcludeKind;
-
 use super::{Class, ClassKind, TemplateKind};
+use crate::element::ExcludeKind;
 
 #[derive(Clone, Debug, PartialEq, Eq, Hash)]
 pub struct ClassDesc<'tu, 'ge> {
@@ -114,6 +113,11 @@ impl<'tu, 'ge> ClassDesc<'tu, 'ge> {
 		Class::new_desc(Self::system("cv::String", "core"))
 	}
 
+	/// `std::String`
+	pub fn std_string() -> Class<'tu, 'ge> {
+		Class::new_desc(Self::system("std::string", "core"))
+	}
+
 	/// `cv::MatConstIterator`
 	pub fn cv_matconstiterator() -> Class<'tu, 'ge> {
 		Class::new_desc(Self::boxed("cv::MatConstIterator", "core"))

binding-generator/src/settings/func_inject.rs

@@ -38,6 +38,23 @@ pub fn func_inject_factory(module: &str) -> Vec<FuncFactory> {
 					TypeRefDesc::cv_size(),
 				))
 			},
+			|| {
+				Func::new_desc(
+					FuncDesc::new(
+						InstanceMethod(ClassDesc::cv_mat()),
+						Const,
+						Fallible,
+						"getDataDump",
+						"core",
+						[],
+						TypeRefDesc::std_string(),
+					)
+					.cpp_body(FuncCppBody::ManualCall(
+						"std::string();\nstd::ostringstream oss;\noss << *instance;\nret = oss.str()".into(),
+					))
+					.doc_comment("Return the dump of the Mat's data"),
+				)
+			},
 			|| {
 				Func::new_desc(FuncDesc::new(
 					InstanceMethod(ClassDesc::cv_umat()),

binding-generator/src/type_ref/desc.rs

@@ -211,6 +211,11 @@ impl<'tu, 'ge> TypeRefDesc<'tu, 'ge> {
 		TypeRef::new_class(ClassDesc::cv_string())
 	}
 
+	/// `std::string`
+	pub fn std_string() -> TypeRef<'tu, 'ge> {
+		TypeRef::new_class(ClassDesc::std_string())
+	}
+
 	/// `std::vector<std::vector<double>>`
 	pub fn vector_of_vector_of_double() -> TypeRef<'tu, 'ge> {
 		TypeRef::new_vector(Vector::new_desc(VectorDesc::new(TypeRef::new_vector(Vector::new_desc(

src/manual/core/mat.rs

@@ -788,10 +788,25 @@ impl fmt::Debug for Mat {
 			.field("total", &self.total())
 			.field("is_continuous", &self.is_continuous())
 			.field("is_submatrix", &self.is_submatrix())
+			.field("data", &MatDataDumper(self))
 			.finish()
 	}
 }
 
+struct MatDataDumper<'r>(&'r Mat);
+
+impl fmt::Debug for MatDataDumper<'_> {
+	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+		const MAX_DUMP_SIZE: usize = 1000;
+
+		if self.0.total() <= MAX_DUMP_SIZE {
+			f.write_str(&self.0.get_data_dump().map_err(|_| fmt::Error)?)
+		} else {
+			f.write_fmt(format_args!("<element count is higher than threshold: {MAX_DUMP_SIZE}>"))
+		}
+	}
+}
+
 input_output_array! { UMat, from_umat, from_umat_mut }
 input_output_array_vector! { UMat, from_umat_vec, from_umat_vec_mut }