use std::str::FromStr;use crate::{Kind, ObjectId, oid};#[cfg(feature = "sha1")]use crate::{SIZE_OF_SHA1_DIGEST, SIZE_OF_SHA1_HEX_DIGEST};#[cfg(feature = "sha256")]use crate::{SIZE_OF_SHA256_DIGEST, SIZE_OF_SHA256_HEX_DIGEST};impl TryFrom<u8> for Kind { type Error = u8; fn try_from(value: u8) -> Result<Self, Self::Error> { Ok(match value { #[cfg(feature = "sha1")] 1 => Kind::Sha1, #[cfg(feature = "sha256")] 2 => Kind::Sha256, unknown => return Err(unknown), }) }}impl FromStr for Kind { type Err = String; fn from_str(s: &str) -> Result<Self, Self::Err> { Ok(match s { #[cfg(feature = "sha1")] "sha1" | "SHA1" | "SHA-1" => Kind::Sha1, #[cfg(feature = "sha256")] "sha256" | "SHA256" | "SHA-256" => Kind::Sha256, other => return Err(other.into()), }) }}impl std::fmt::Display for Kind { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { match self { #[cfg(feature = "sha1")] Kind::Sha1 => f.write_str("sha1"), #[cfg(feature = "sha256")] Kind::Sha256 => f.write_str("sha256"), } }}impl Kind { /// Returns the shortest hash we support. #[inline] pub const fn shortest() -> Self { #[cfg(all(not(feature = "sha1"), feature = "sha256"))] { Self::Sha256 } #[cfg(feature = "sha1")] { Self::Sha1 } } /// Returns the longest hash we support. #[inline] pub const fn longest() -> Self { #[cfg(feature = "sha256")] { Self::Sha256 } #[cfg(all(not(feature = "sha256"), feature = "sha1"))] { Self::Sha1 } } /// Returns a buffer suitable to hold the longest possible hash in hex. #[inline] pub const fn hex_buf() -> [u8; Kind::longest().len_in_hex()] { [0u8; Kind::longest().len_in_hex()] } /// Returns a buffer suitable to hold the longest possible hash as raw bytes. #[inline] pub const fn buf() -> [u8; Kind::longest().len_in_bytes()] { [0u8; Kind::longest().len_in_bytes()] } /// Returns the amount of bytes needed to encode this instance as hexadecimal characters. #[inline] pub const fn len_in_hex(&self) -> usize { match self { #[cfg(feature = "sha1")] Kind::Sha1 => SIZE_OF_SHA1_HEX_DIGEST, #[cfg(feature = "sha256")] Kind::Sha256 => SIZE_OF_SHA256_HEX_DIGEST, } } /// Returns the amount of bytes taken up by the hash of this instance. #[inline] pub const fn len_in_bytes(&self) -> usize { match self { #[cfg(feature = "sha1")] Kind::Sha1 => SIZE_OF_SHA1_DIGEST, #[cfg(feature = "sha256")] Kind::Sha256 => SIZE_OF_SHA256_DIGEST, } } /// Returns the kind of hash that would fit the given `hex_len`, or `None` if there is no fitting hash. /// Note that `0` as `hex_len` up to 40 always yields SHA-1 while anything in the range 41..64 /// always yields SHA-256 if it is enabled. #[inline] pub const fn from_hex_len(hex_len: usize) -> Option<Self> { Some(match hex_len { #[cfg(feature = "sha1")] 0..=SIZE_OF_SHA1_HEX_DIGEST => Kind::Sha1, #[cfg(feature = "sha256")] 0..=SIZE_OF_SHA256_HEX_DIGEST => Kind::Sha256, _ => return None, }) } /// Converts a size in bytes as obtained by `Kind::len_in_bytes()` into the corresponding hash kind, if possible. /// /// **Panics** if the hash length doesn't match a known hash. /// /// NOTE that this method isn't public as it shouldn't be encouraged to assume all hashes have the same length. /// However, if there should be such a thing, our `oid` implementation will have to become an enum and it's pretty breaking /// to the way it's currently being used as auto-dereffing doesn't work anymore. Let's hope it won't happen. // TODO: make 'const' once Rust 1.57 is more readily available in projects using 'gitoxide'. #[inline] pub(crate) fn from_len_in_bytes(bytes: usize) -> Self { match bytes { #[cfg(feature = "sha1")] SIZE_OF_SHA1_DIGEST => Kind::Sha1, #[cfg(feature = "sha256")] SIZE_OF_SHA256_DIGEST => Kind::Sha256, _ => panic!("BUG: must be called only with valid hash lengths produced by len_in_bytes()"), } } /// Create a shared null-id of our hash kind. #[inline] pub fn null_ref(&self) -> &'static oid { match self { #[cfg(feature = "sha1")] Kind::Sha1 => oid::null_sha1(), #[cfg(feature = "sha256")] Kind::Sha256 => oid::null_sha256(), } } /// Create an owned null-id of our hash kind. #[inline] pub const fn null(&self) -> ObjectId { match self { #[cfg(feature = "sha1")] Kind::Sha1 => ObjectId::null_sha1(), #[cfg(feature = "sha256")] Kind::Sha256 => ObjectId::null_sha256(), } } /// The hash of an empty blob. #[inline] pub const fn empty_blob(&self) -> ObjectId { ObjectId::empty_blob(*self) } /// The hash of an empty tree. #[inline] pub const fn empty_tree(&self) -> ObjectId { ObjectId::empty_tree(*self) } /// Return a list of available hash kinds. #[inline] pub const fn all() -> &'static [Self] { #[cfg(all(feature = "sha1", not(feature = "sha256")))] { &[Self::Sha1] } #[cfg(all(not(feature = "sha1"), feature = "sha256"))] { &[Self::Sha256] } #[cfg(all(feature = "sha1", feature = "sha256"))] { &[Self::Sha1, Self::Sha256] } }}
use std::str::FromStr;
use crate::{Kind, ObjectId, oid};
#[cfg(feature = "sha1")]
use crate::{SIZE_OF_SHA1_DIGEST, SIZE_OF_SHA1_HEX_DIGEST};
#[cfg(feature = "sha256")]
use crate::{SIZE_OF_SHA256_DIGEST, SIZE_OF_SHA256_HEX_DIGEST};
impl TryFrom<u8> for Kind {
type Error = u8;
fn try_from(value: u8) -> Result<Self, Self::Error> {
Ok(match value {
#[cfg(feature = "sha1")]
1 => Kind::Sha1,
#[cfg(feature = "sha256")]
2 => Kind::Sha256,
unknown => return Err(unknown),
})
}
}
impl FromStr for Kind {
type Err = String;
fn from_str(s: &str) -> Result<Self, Self::Err> {
Ok(match s {
#[cfg(feature = "sha1")]
"sha1" | "SHA1" | "SHA-1" => Kind::Sha1,
#[cfg(feature = "sha256")]
"sha256" | "SHA256" | "SHA-256" => Kind::Sha256,
other => return Err(other.into()),
})
}
}
impl std::fmt::Display for Kind {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
#[cfg(feature = "sha1")]
Kind::Sha1 => f.write_str("sha1"),
#[cfg(feature = "sha256")]
Kind::Sha256 => f.write_str("sha256"),
}
}
}
impl Kind {
/// Returns the shortest hash we support.
#[inline]
pub const fn shortest() -> Self {
#[cfg(all(not(feature = "sha1"), feature = "sha256"))]
{
Self::Sha256
}
#[cfg(feature = "sha1")]
{
Self::Sha1
}
}
/// Returns the longest hash we support.
#[inline]
pub const fn longest() -> Self {
#[cfg(feature = "sha256")]
{
Self::Sha256
}
#[cfg(all(not(feature = "sha256"), feature = "sha1"))]
{
Self::Sha1
}
}
/// Returns a buffer suitable to hold the longest possible hash in hex.
#[inline]
pub const fn hex_buf() -> [u8; Kind::longest().len_in_hex()] {
[0u8; Kind::longest().len_in_hex()]
}
/// Returns a buffer suitable to hold the longest possible hash as raw bytes.
#[inline]
pub const fn buf() -> [u8; Kind::longest().len_in_bytes()] {
[0u8; Kind::longest().len_in_bytes()]
}
/// Returns the amount of bytes needed to encode this instance as hexadecimal characters.
#[inline]
pub const fn len_in_hex(&self) -> usize {
match self {
#[cfg(feature = "sha1")]
Kind::Sha1 => SIZE_OF_SHA1_HEX_DIGEST,
#[cfg(feature = "sha256")]
Kind::Sha256 => SIZE_OF_SHA256_HEX_DIGEST,
}
}
/// Returns the amount of bytes taken up by the hash of this instance.
#[inline]
pub const fn len_in_bytes(&self) -> usize {
match self {
#[cfg(feature = "sha1")]
Kind::Sha1 => SIZE_OF_SHA1_DIGEST,
#[cfg(feature = "sha256")]
Kind::Sha256 => SIZE_OF_SHA256_DIGEST,
}
}
/// Returns the kind of hash that would fit the given `hex_len`, or `None` if there is no fitting hash.
/// Note that `0` as `hex_len` up to 40 always yields SHA-1 while anything in the range 41..64
/// always yields SHA-256 if it is enabled.
#[inline]
pub const fn from_hex_len(hex_len: usize) -> Option<Self> {
Some(match hex_len {
#[cfg(feature = "sha1")]
0..=SIZE_OF_SHA1_HEX_DIGEST => Kind::Sha1,
#[cfg(feature = "sha256")]
0..=SIZE_OF_SHA256_HEX_DIGEST => Kind::Sha256,
_ => return None,
})
}
/// Converts a size in bytes as obtained by `Kind::len_in_bytes()` into the corresponding hash kind, if possible.
///
/// **Panics** if the hash length doesn't match a known hash.
///
/// NOTE that this method isn't public as it shouldn't be encouraged to assume all hashes have the same length.
/// However, if there should be such a thing, our `oid` implementation will have to become an enum and it's pretty breaking
/// to the way it's currently being used as auto-dereffing doesn't work anymore. Let's hope it won't happen.
// TODO: make 'const' once Rust 1.57 is more readily available in projects using 'gitoxide'.
#[inline]
pub(crate) fn from_len_in_bytes(bytes: usize) -> Self {
match bytes {
#[cfg(feature = "sha1")]
SIZE_OF_SHA1_DIGEST => Kind::Sha1,
#[cfg(feature = "sha256")]
SIZE_OF_SHA256_DIGEST => Kind::Sha256,
_ => panic!("BUG: must be called only with valid hash lengths produced by len_in_bytes()"),
}
}
/// Create a shared null-id of our hash kind.
#[inline]
pub fn null_ref(&self) -> &'static oid {
match self {
#[cfg(feature = "sha1")]
Kind::Sha1 => oid::null_sha1(),
#[cfg(feature = "sha256")]
Kind::Sha256 => oid::null_sha256(),
}
}
/// Create an owned null-id of our hash kind.
#[inline]
pub const fn null(&self) -> ObjectId {
match self {
#[cfg(feature = "sha1")]
Kind::Sha1 => ObjectId::null_sha1(),
#[cfg(feature = "sha256")]
Kind::Sha256 => ObjectId::null_sha256(),
}
}
/// The hash of an empty blob.
#[inline]
pub const fn empty_blob(&self) -> ObjectId {
ObjectId::empty_blob(*self)
}
/// The hash of an empty tree.
#[inline]
pub const fn empty_tree(&self) -> ObjectId {
ObjectId::empty_tree(*self)
}
/// Return a list of available hash kinds.
#[inline]
pub const fn all() -> &'static [Self] {
#[cfg(all(feature = "sha1", not(feature = "sha256")))]
{
&[Self::Sha1]
}
#[cfg(all(not(feature = "sha1"), feature = "sha256"))]
{
&[Self::Sha256]
}
#[cfg(all(feature = "sha1", feature = "sha256"))]
{
&[Self::Sha1, Self::Sha256]
}
}
}