Struct libojo::PatchId

pub struct PatchId { /* fields omitted */ }

A global identifier for a patch.

A PatchId is derived from a patch by hashing its contents. It must be unique: a repository cannot simultaneously contain two patches with the same id.

Methods

impl PatchId

pub fn cur() -> PatchId

There is a special reserved PatchId for patches that are under construction, but not yet finished (see UnidentifiedPatch for more details). This function returns that special id.

pub fn is_cur(&self) -> bool

Checks whether this PatchId is the one decribed in PatchId::cur.

pub fn to_base64(&self) -> String

Represents this PatchId in base64.

We encode in the URL_SAFE encoding because it needs to be a valid path (e.g. no slashes). We prepend the letter 'P', because otherwise there's a chance that the first character will be '-', which is annoying because then the CLI might misinterpret it as a flag.

pub fn from_base64<S: ?Sized + AsRef<[u8]>>(name: &S) -> Result<PatchId, Error>

Converts from base64 (as returned by PatchId::to_base64) to a PatchId.

Trait Implementations

impl PartialEq<PatchId> for PatchId

fn eq(&self, other: &PatchId) -> bool

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

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

This method tests for !=.

impl Ord for PatchId

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl Clone for PatchId

fn clone(&self) -> PatchId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for PatchId

impl Copy for PatchId

impl PartialOrd<PatchId> for PatchId

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

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

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

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

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

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

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

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

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

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

impl Hash for PatchId

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Debug for PatchId

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PatchId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for PatchId

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.