mirror of
https://seed.radicle.dev/rad:z6cFWeWpnZNHh9rUW8phgA3b5yGt.git
synced 2026-11-15 16:00:35 +08:00
Fintan Halpenny
d657572dfd
The file_system types, Label & Path, are overengineered. It's more natural to use the Path and PathBuf types provided by the std library. This replaces any mention of Label with String and any use of the old Path with either std::path::Path or std::path::PathBuf, depending on what kind of ownwership is needed. Anywhere a "root" directory is needed `PathBuf::new()` is used, i.e. an empty `PathBuf`. Otherwise `Path::new` can used to pass directory, or in fact a &str can also be used since it implements AsRef<Path>. The `File` and `Directory` types also contain there relative paths, which can be retrieved while traversing the Tree. Note the special file name `"special/faux\\path"` requires the use of an escaping string construction, i.e. `r"special/faux\\path"`. Signed-off-by: Fintan Halpenny <fintan.halpenny@gmail.com> X-Clacks-Overhead: GNU Terry Pratchett
100 lines
2.9 KiB
Rust
100 lines
2.9 KiB
Rust
// This file is part of radicle-surf
|
|
// <https://github.com/radicle-dev/radicle-surf>
|
|
//
|
|
// Copyright (C) 2019-2020 The Radicle Team <dev@radicle.xyz>
|
|
//
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License version 3 or
|
|
// later as published by the Free Software Foundation.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
//! Common definitions for git objects (blob and tree).
|
|
//! See git [doc](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects) for more details.
|
|
|
|
use std::path::PathBuf;
|
|
|
|
#[cfg(feature = "serialize")]
|
|
use serde::{
|
|
ser::{SerializeStruct as _, Serializer},
|
|
Serialize,
|
|
};
|
|
|
|
pub mod blob;
|
|
pub use blob::{Blob, BlobContent};
|
|
|
|
pub mod tree;
|
|
pub use tree::{tree, Tree, TreeEntry};
|
|
|
|
use crate::{commit, file_system::directory, git};
|
|
|
|
/// Git object types.
|
|
///
|
|
/// `shafiul.github.io/gitbook/1_the_git_object_model.html`
|
|
#[derive(Debug, Eq, Ord, PartialOrd, PartialEq)]
|
|
pub enum ObjectType {
|
|
/// References a list of other trees and blobs.
|
|
Tree,
|
|
/// Used to store file data.
|
|
Blob,
|
|
}
|
|
|
|
#[cfg(feature = "serialize")]
|
|
impl Serialize for ObjectType {
|
|
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
|
|
where
|
|
S: Serializer,
|
|
{
|
|
match self {
|
|
Self::Blob => serializer.serialize_unit_variant("ObjectType", 0, "BLOB"),
|
|
Self::Tree => serializer.serialize_unit_variant("ObjectType", 1, "TREE"),
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Set of extra information we carry for blob and tree objects returned from
|
|
/// the API.
|
|
pub struct Info {
|
|
/// Name part of an object.
|
|
pub name: String,
|
|
/// The type of the object.
|
|
pub object_type: ObjectType,
|
|
/// The last commmit that touched this object.
|
|
pub last_commit: Option<commit::Header>,
|
|
}
|
|
|
|
#[cfg(feature = "serialize")]
|
|
impl Serialize for Info {
|
|
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
|
|
where
|
|
S: Serializer,
|
|
{
|
|
let mut state = serializer.serialize_struct("Info", 3)?;
|
|
state.serialize_field("name", &self.name)?;
|
|
state.serialize_field("objectType", &self.object_type)?;
|
|
state.serialize_field("lastCommit", &self.last_commit)?;
|
|
state.end()
|
|
}
|
|
}
|
|
|
|
/// An error reported by object types.
|
|
#[derive(Debug, thiserror::Error)]
|
|
pub enum Error {
|
|
#[error(transparent)]
|
|
Directory(#[from] directory::error::Directory),
|
|
|
|
/// An error occurred during a git operation.
|
|
#[error(transparent)]
|
|
Git(#[from] git::Error),
|
|
|
|
/// Trying to find a file path which could not be found.
|
|
#[error("the path '{0}' was not found")]
|
|
PathNotFound(PathBuf),
|
|
}
|