[gix-object] EntryMode: Hide the internal data representation

We'll want to change it to fix issue GitoxideLabs#1887.

First step: don't expose it.

Author: pierrechevalier83

gitoxide-core/src/repository/diff.rs

@@ -49,7 +49,7 @@ fn write_changes(
             } => {
                 writeln!(out, "A: {}", typed_location(location, entry_mode))?;
                 writeln!(out, "  {}", id.attach(repo).shorten_or_id())?;
-                writeln!(out, "  -> {:o}", entry_mode.0)?;
+                writeln!(out, "  -> {:o}", entry_mode)?;
             }
             gix::diff::tree_with_rewrites::Change::Deletion {
                 location,
@@ -59,7 +59,7 @@ fn write_changes(
             } => {
                 writeln!(out, "D: {}", typed_location(location, entry_mode))?;
                 writeln!(out, "  {}", id.attach(repo).shorten_or_id())?;
-                writeln!(out, "  {:o} ->", entry_mode.0)?;
+                writeln!(out, "  {:o} ->", entry_mode)?;
             }
             gix::diff::tree_with_rewrites::Change::Modification {
                 location,
@@ -76,7 +76,7 @@ fn write_changes(
                     id = id.attach(repo).shorten_or_id()
                 )?;
                 if previous_entry_mode != entry_mode {
-                    writeln!(out, "  {:o} -> {:o}", previous_entry_mode.0, entry_mode.0)?;
+                    writeln!(out, "  {:o} -> {:o}", previous_entry_mode, entry_mode)?;
                 }
             }
             gix::diff::tree_with_rewrites::Change::Rewrite {
@@ -101,7 +101,7 @@ fn write_changes(
                     id = id.attach(repo).shorten_or_id()
                 )?;
                 if source_entry_mode != entry_mode {
-                    writeln!(out, "  {:o} -> {:o}", source_entry_mode.0, entry_mode.0)?;
+                    writeln!(out, "  {:o} -> {:o}", source_entry_mode, entry_mode)?;
                 }
             }
         }

gix-index/src/entry/mode.rs

@@ -71,7 +71,8 @@ impl Mode {
 
 impl From<gix_object::tree::EntryMode> for Mode {
     fn from(value: gix_object::tree::EntryMode) -> Self {
-        Self::from_bits_truncate(u32::from(value.0))
+        let value: u16 = value.into();
+        Self::from_bits_truncate(u32::from(value))
     }
 }
 

gix-object/src/tree/mod.rs

@@ -4,6 +4,7 @@ use crate::{
 };
 use std::cell::RefCell;
 use std::cmp::Ordering;
+use std::fmt;
 
 ///
 pub mod editor;
@@ -44,14 +45,20 @@ pub struct Editor<'a> {
 /// create it by converting [`EntryKind`] into `EntryMode`.
 #[derive(Clone, Copy, PartialEq, Eq, Ord, PartialOrd, Hash)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
-pub struct EntryMode(pub u16);
+pub struct EntryMode(u16);
 
 impl std::fmt::Debug for EntryMode {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         write!(f, "EntryMode({:#o})", self.0)
     }
 }
 
+impl std::fmt::Octal for EntryMode {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        write!(f, "{:o}", self.0)
+    }
+}
+
 /// A discretized version of ideal and valid values for entry modes.
 ///
 /// Note that even though it can represent every valid [mode](EntryMode), it might
@@ -72,6 +79,18 @@ pub enum EntryKind {
     Commit = 0o160000,
 }
 
+impl From<u16> for EntryMode {
+    fn from(value: u16) -> Self {
+        EntryMode(value)
+    }
+}
+
+impl From<EntryMode> for u16 {
+    fn from(value: EntryMode) -> Self {
+        value.0
+    }
+}
+
 impl From<EntryKind> for EntryMode {
     fn from(value: EntryKind) -> Self {
         EntryMode(value as u16)
@@ -199,6 +218,11 @@ impl EntryMode {
         }
         .into()
     }
+
+    /// Display the octal representation of this EntryMode
+    pub fn as_octal_representation(&self) -> fmt::Result {
+        Ok(print!("{:o}", self.0))
+    }
 }
 
 impl TreeRef<'_> {

gix-object/tests/object/tree/entry_mode.rs

@@ -16,11 +16,11 @@ fn is_methods() {
     }
 
     assert!(mode(EntryKind::Blob).is_blob());
-    assert!(EntryMode(0o100645).is_blob());
-    assert_eq!(EntryMode(0o100645).kind(), EntryKind::Blob);
-    assert!(!EntryMode(0o100675).is_executable());
-    assert!(EntryMode(0o100700).is_executable());
-    assert_eq!(EntryMode(0o100700).kind(), EntryKind::BlobExecutable);
+    assert!(EntryMode::from(0o100645).is_blob());
+    assert_eq!(EntryMode::from(0o100645).kind(), EntryKind::Blob);
+    assert!(!EntryMode::from(0o100675).is_executable());
+    assert!(EntryMode::from(0o100700).is_executable());
+    assert_eq!(EntryMode::from(0o100700).kind(), EntryKind::BlobExecutable);
     assert!(!mode(EntryKind::Blob).is_link());
     assert!(mode(EntryKind::BlobExecutable).is_blob());
     assert!(mode(EntryKind::BlobExecutable).is_executable());
@@ -29,17 +29,17 @@ fn is_methods() {
 
     assert!(!mode(EntryKind::Link).is_blob());
     assert!(mode(EntryKind::Link).is_link());
-    assert!(EntryMode(0o121234).is_link());
-    assert_eq!(EntryMode(0o121234).kind(), EntryKind::Link);
+    assert!(EntryMode::from(0o121234).is_link());
+    assert_eq!(EntryMode::from(0o121234).kind(), EntryKind::Link);
     assert!(mode(EntryKind::Link).is_blob_or_symlink());
     assert!(mode(EntryKind::Tree).is_tree());
-    assert!(EntryMode(0o040101).is_tree());
-    assert_eq!(EntryMode(0o040101).kind(), EntryKind::Tree);
+    assert!(EntryMode::from(0o040101).is_tree());
+    assert_eq!(EntryMode::from(0o040101).kind(), EntryKind::Tree);
     assert!(mode(EntryKind::Commit).is_commit());
-    assert!(EntryMode(0o167124).is_commit());
-    assert_eq!(EntryMode(0o167124).kind(), EntryKind::Commit);
+    assert!(EntryMode::from(0o167124).is_commit());
+    assert_eq!(EntryMode::from(0o167124).kind(), EntryKind::Commit);
     assert_eq!(
-        EntryMode(0o000000).kind(),
+        EntryMode::from(0o000000).kind(),
         EntryKind::Commit,
         "commit is really 'anything else' as `kind()` can't fail"
     );