Struct Patch 

pub struct Patch { /* private fields */ }

Patch state.

Implementations

impl Patch

pub fn new( title: Title, target: MergeTarget, (id, revision): (RevisionId, Revision), ) -> Self

Construct a new patch object from a revision.

pub fn title(&self) -> &str

Title of the patch.

pub fn state(&self) -> &State

Current state of the patch.

pub fn target(&self) -> MergeTarget

Target this patch is meant to be merged in.

pub fn timestamp(&self) -> Timestamp

Timestamp of the first revision of the patch.

pub fn labels(&self) -> impl Iterator<Item = &Label>

Associated labels.

pub fn description(&self) -> &str

Patch description.

pub fn embeds(&self) -> &[Embed<Uri>]

Patch embeds.

pub fn author(&self) -> &Author

Author of the first revision of the patch.

pub fn authors(&self) -> BTreeSet<&Author>

All revision authors.

pub fn revision(&self, id: &RevisionId) -> Option<&Revision>

Get the Revision by its RevisionId.

None is returned if the Revision has been redacted (deleted).

pub fn updates( &self, ) -> impl DoubleEndedIterator<Item = (RevisionId, &Revision)>

List of patch revisions by the patch author. The initial changeset is part of the first revision.

pub fn revisions( &self, ) -> impl DoubleEndedIterator<Item = (RevisionId, &Revision)>

List of all patch revisions by all authors.

pub fn revisions_by<'a>( &'a self, author: &'a PublicKey, ) -> impl DoubleEndedIterator<Item = (RevisionId, &'a Revision)>

List of patch revisions by the given author.

pub fn reviews_of( &self, rev: RevisionId, ) -> impl Iterator<Item = (&ReviewId, &Review)>

List of patch reviews of the given revision.

pub fn assignees(&self) -> impl Iterator<Item = Did> + '_

List of patch assignees.

pub fn merges(&self) -> impl Iterator<Item = (&ActorId, &Merge)>

Get the merges.

pub fn head(&self) -> &Oid

Reference to the Git object containing the code on the latest revision.

pub fn base(&self) -> &Oid

Get the commit of the target branch on which this patch is based. This can change via a patch update.

pub fn merge_base<R: ReadRepository>(&self, repo: &R) -> Result<Oid, Error>

Get the merge base of this patch.

pub fn range(&self) -> Result<(Oid, Oid), Error>

Get the commit range of this patch.

pub fn version(&self) -> RevisionIx

Index of latest revision in the revisions list.

pub fn root(&self) -> (RevisionId, &Revision)

Root revision.

This is the revision that was created with the patch.

pub fn latest(&self) -> (RevisionId, &Revision)

Latest revision by the patch author.

pub fn latest_by<'a>( &'a self, author: &'a PublicKey, ) -> Option<(RevisionId, &'a Revision)>

Latest revision by the given author.

pub fn updated_at(&self) -> Timestamp

Time of last update.

pub fn is_merged(&self) -> bool

Check if the patch is merged.

pub fn is_open(&self) -> bool

Check if the patch is open.

pub fn is_archived(&self) -> bool

Check if the patch is archived.

pub fn is_draft(&self) -> bool

Check if the patch is a draft.

pub fn authorization( &self, action: &Action, actor: &ActorId, doc: &Doc, ) -> Result<Authorization, Error>

Apply authorization rules on patch actions.

Trait Implementations

impl Clone for Patch

fn clone(&self) -> Patch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Cob for Patch

type Action = Action

The underlying action composing each operation.

type Error = Error

Error returned by apply function.

fn from_root<R: ReadRepository>(op: Op, repo: &R) -> Result<Self, Self::Error>

Initialize a collaborative object from a root operation.

fn op<'a, R: ReadRepository, I: IntoIterator<Item = &'a Entry>>( &mut self, op: Op, concurrent: I, repo: &R, ) -> Result<(), Error>

Apply an operation to the state.

impl CobWithType for Patch

fn type_name() -> &'static TypeName

The type name of the collaborative object type which backs this implementation.

impl Debug for Patch

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Patch

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<R: ReadRepository> Evaluate<R> for Patch

type Error = Error

fn init(entry: &Entry, repo: &R) -> Result<Self, Self::Error>

Initialize the object with the first (root) history entry.

fn apply<'a, I: Iterator<Item = (&'a EntryId, &'a Entry)>>( &mut self, entry: &Entry, concurrent: I, repo: &R, ) -> Result<(), Self::Error>

Apply a history entry to the evaluated state.

impl PartialEq for Patch

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<R, C> Remove<Patch> for Cache<R, C>

where C: Remove<Patch>,

type Out = <C as Remove<Patch>>::Out

The output type, if any, for a successful removal.

type RemoveError = <C as Remove<Patch>>::RemoveError

fn remove(&mut self, id: &ObjectId) -> Result<Self::Out, Self::RemoveError>

Delete an object in the COB cache.

fn remove_all(&mut self, rid: &RepoId) -> Result<Self::Out, Self::RemoveError>

Delete all entries from a repo.

impl Remove<Patch> for StoreWriter

type Out = bool

The output type, if any, for a successful removal.

type RemoveError = Error

fn remove(&mut self, id: &ObjectId) -> Result<Self::Out, Self::RemoveError>

Delete an object in the COB cache.

fn remove_all(&mut self, rid: &RepoId) -> Result<Self::Out, Self::RemoveError>

Delete all entries from a repo.

impl Serialize for Patch

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<R, C> Update<Patch> for Cache<R, C>

where C: Update<Patch>,

type Out = <C as Update<Patch>>::Out

The output type, if any, for a successful update.

type UpdateError = <C as Update<Patch>>::UpdateError

fn update( &mut self, rid: &RepoId, id: &ObjectId, object: &Patch, ) -> Result<Self::Out, Self::UpdateError>

impl Update<Patch> for StoreWriter

type Out = bool

The output type, if any, for a successful update.

type UpdateError = UpdateError

fn update( &mut self, rid: &RepoId, id: &ObjectId, object: &Patch, ) -> Result<Self::Out, Self::UpdateError>

impl Eq for Patch

impl StructuralPartialEq for Patch