Struct radicle_surf::vcs::History

pub struct History<A>(pub NonEmpty<A>);

A non-empty bag of artifacts which are used to derive a Directory view. Examples of artifacts would be commits in Git or patches in Pijul.

Methods

impl<A> History<A>

pub fn new(a: A) -> Self

pub fn push(&mut self, a: A)

pub fn iter<'a>(&'a self) -> impl Iterator<Item = &A> + 'a

Iterator over the artifacts.

pub fn first(&self) -> &A

pub fn find_suffix(&self, artifact: &A) -> Option<Self> where
    A: Clone + PartialEq, 

Given that the History is topological order from most recent artifact to least recent, find_suffix gets returns the history up until the point of the given artifact.

This operation may fail if the artifact does not exist in the given History.

pub fn map<F, B>(&self, f: F) -> History<B> where
    F: Fn(&A) -> B, 

pub fn find<F, B>(&self, f: F) -> Option<B> where
    F: Fn(&A) -> Option<B>, 

pub fn find_in_history<Identifier, F>(
    &self,
    identifier: &Identifier,
    id_of: F
) -> Option<A> where
    A: Clone,
    F: Fn(&A) -> Identifier,
    Identifier: PartialEq, 

Find an atrifact in the given History using the artifacts ID.

This operation may fail if the artifact does not exist in the history.

pub fn find_in_histories<Identifier, F>(
    histories: Vec<Self>,
    identifier: &Identifier,
    id_of: F
) -> Vec<Self> where
    A: Clone,
    F: Fn(&A) -> Identifier + Copy,
    Identifier: PartialEq, 

Find all occurences of an artifact in a bag of Historys.

Trait Implementations

impl<A: Clone> Clone for History<A>

fn clone(&self) -> History<A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Debug> Debug for History<A>

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

Formats the value using the given formatter.

impl<A: Eq> Eq for History<A>

impl<A: Ord> Ord for History<A>

fn cmp(&self, other: &History<A>) -> 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.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<A: PartialEq> PartialEq<History<A>> for History<A>

fn eq(&self, other: &History<A>) -> bool

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

fn ne(&self, other: &History<A>) -> bool

This method tests for !=.

impl<A: PartialOrd> PartialOrd<History<A>> for History<A>

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

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

fn lt(&self, other: &History<A>) -> bool

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

fn le(&self, other: &History<A>) -> bool

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

fn gt(&self, other: &History<A>) -> bool

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

fn ge(&self, other: &History<A>) -> bool

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

impl<A> StructuralEq for History<A>

impl<A> StructuralPartialEq for History<A>