summaryrefslogtreecommitdiffstats
path: root/vendor/gix-index/src/file/mod.rs
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/gix-index/src/file/mod.rs')
-rw-r--r--vendor/gix-index/src/file/mod.rs90
1 files changed, 90 insertions, 0 deletions
diff --git a/vendor/gix-index/src/file/mod.rs b/vendor/gix-index/src/file/mod.rs
new file mode 100644
index 000000000..40332abbd
--- /dev/null
+++ b/vendor/gix-index/src/file/mod.rs
@@ -0,0 +1,90 @@
+mod impls {
+ use std::ops::{Deref, DerefMut};
+
+ use crate::{File, State};
+
+ impl Deref for File {
+ type Target = State;
+
+ fn deref(&self) -> &Self::Target {
+ &self.state
+ }
+ }
+
+ impl DerefMut for File {
+ fn deref_mut(&mut self) -> &mut Self::Target {
+ &mut self.state
+ }
+ }
+}
+
+mod impl_ {
+ use std::fmt::Formatter;
+
+ use crate::{File, State};
+
+ impl std::fmt::Debug for File {
+ fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+ f.debug_struct("File")
+ .field("path", &self.path.display())
+ .field("checksum", &self.checksum)
+ .finish_non_exhaustive()
+ }
+ }
+
+ impl From<File> for State {
+ fn from(f: File) -> Self {
+ f.state
+ }
+ }
+}
+
+mod access {
+ use crate::File;
+
+ /// Consumption
+ impl File {
+ /// Take all non-copy parts of the index.
+ pub fn into_parts(self) -> (crate::State, std::path::PathBuf) {
+ (self.state, self.path)
+ }
+ }
+
+ /// Access
+ impl File {
+ /// The path from which the index was read or to which it is supposed to be written when used with [`File::from_state()`].
+ pub fn path(&self) -> &std::path::Path {
+ &self.path
+ }
+
+ /// The checksum over the file that was read or written to disk, or `None` if the state in memory was never serialized.
+ ///
+ /// Note that even if `Some`, it will only represent the state in memory right after reading or [writing][File::write()].
+ pub fn checksum(&self) -> Option<gix_hash::ObjectId> {
+ self.checksum
+ }
+ }
+}
+
+mod mutation {
+ use std::path::PathBuf;
+
+ use crate::File;
+
+ /// Mutating access
+ impl File {
+ /// Set the path at which we think we are located to the given `path`.
+ ///
+ /// This is useful to change the location of the index *once* it is written via [`write()`][File::write()].
+ pub fn set_path(&mut self, path: impl Into<PathBuf>) {
+ self.path = path.into();
+ }
+ }
+}
+
+///
+pub mod init;
+///
+pub mod verify;
+///
+pub mod write;