Struct gitoid::GitOid

#[repr(C)]
pub struct GitOid<H, O>
where
    H: HashAlgorithm,
    O: ObjectType,
{ /* private fields */ }

A struct that computes gitoids based on the selected algorithm

Implementations

impl<H, O> GitOid<H, O>

where H: HashAlgorithm, O: ObjectType,

pub fn id_bytes<B: AsRef<[u8]>>(content: B) -> GitOid<H, O>

Create a new GitOid based on a slice of bytes.

pub fn id_str<S: AsRef<str>>(s: S) -> GitOid<H, O>

Create a GitOid from a UTF-8 string slice.

pub fn id_reader<R: Read + Seek>(reader: R) -> Result<GitOid<H, O>, Error>

Create a GitOid from a reader.

pub fn id_reader_with_length<R: Read>( reader: R, expected_length: usize ) -> Result<GitOid<H, O>, Error>

Generate a GitOid from a reader, providing an expected length in bytes.

pub async fn id_async_reader<R: AsyncRead + AsyncSeek + Unpin>( reader: R ) -> Result<GitOid<H, O>, Error>

Generate a GitOid from an asynchronous reader.

pub async fn id_async_reader_with_length<R: AsyncRead + Unpin>( reader: R, expected_length: usize ) -> Result<GitOid<H, O>, Error>

Generate a GitOid from an asynchronous reader, providing an expected length in bytes.

pub fn try_from_url(url: Url) -> Result<GitOid<H, O>, Error>

Construct a new GitOid from a Url.

pub fn url(&self) -> Url

Get a URL for the current GitOid.

pub fn as_bytes(&self) -> &[u8]

Get the underlying bytes of the hash.

pub fn as_hex(&self) -> String

Convert the hash to a hexadecimal string.

pub const fn hash_algorithm(&self) -> &'static str

Get the hash algorithm used for the GitOid.

pub const fn object_type(&self) -> &'static str

Get the object type of the GitOid.

pub fn hash_len(&self) -> usize

Get the length of the hash in bytes.

Trait Implementations

impl<H, O> Clone for GitOid<H, O>

where H: HashAlgorithm, O: ObjectType,

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<H, O> Debug for GitOid<H, O>

where H: HashAlgorithm, O: ObjectType,

fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult

Formats the value using the given formatter.

impl<'de, H, O> Deserialize<'de> for GitOid<H, O>

where H: HashAlgorithm, O: ObjectType,

fn deserialize<D>(deserializer: D) -> StdResult<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<H, O> Display for GitOid<H, O>

where H: HashAlgorithm, O: ObjectType,

fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult

Formats the value using the given formatter.

impl<H, O> FromStr for GitOid<H, O>

where H: HashAlgorithm, O: ObjectType,

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<GitOid<H, O>, Error>

Parses a string s to return a value of this type.

impl<H, O> Hash for GitOid<H, O>

where H: HashAlgorithm, O: ObjectType,

fn hash<H2>(&self, state: &mut H2)

where H2: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<H, O> Ord for GitOid<H, O>

where H: HashAlgorithm, O: ObjectType,

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<H, O> PartialEq for GitOid<H, O>

where H: HashAlgorithm, O: ObjectType,

fn eq(&self, other: &GitOid<H, O>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<H, O> PartialOrd for GitOid<H, O>

where H: HashAlgorithm, O: ObjectType,

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<H, O> Serialize for GitOid<H, O>

where H: HashAlgorithm, O: ObjectType,

fn serialize<S>(&self, serializer: S) -> StdResult<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<H, O> TryFrom<Url> for GitOid<H, O>

where H: HashAlgorithm, O: ObjectType,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(url: Url) -> Result<GitOid<H, O>, Error>

Performs the conversion.

impl<H, O> Copy for GitOid<H, O>

where H: HashAlgorithm, O: ObjectType,

impl<H, O> Eq for GitOid<H, O>

where H: HashAlgorithm, O: ObjectType,