Struct View

pub struct View { /* private fields */ }

A wrapper around op_store::View that defines additional methods.

Implementations

impl View

pub fn new(op_store_view: View) -> Self

pub fn wc_commit_ids(&self) -> &BTreeMap<WorkspaceNameBuf, CommitId>

pub fn get_wc_commit_id(&self, name: &WorkspaceName) -> Option<&CommitId>

pub fn workspaces_for_wc_commit_id( &self, commit_id: &CommitId, ) -> Vec<WorkspaceNameBuf>

pub fn is_wc_commit_id(&self, commit_id: &CommitId) -> bool

pub fn heads(&self) -> &HashSet<CommitId>

pub fn bookmarks(&self) -> impl Iterator<Item = (&RefName, BookmarkTarget<'_>)>

Iterates pair of local and remote bookmarks by bookmark name.

pub fn tags(&self) -> &BTreeMap<RefNameBuf, RefTarget>

pub fn git_refs(&self) -> &BTreeMap<GitRefNameBuf, RefTarget>

pub fn git_head(&self) -> &RefTarget

pub fn set_wc_commit(&mut self, name: WorkspaceNameBuf, commit_id: CommitId)

pub fn remove_wc_commit(&mut self, name: &WorkspaceName)

pub fn rename_workspace( &mut self, old_name: &WorkspaceName, new_name: WorkspaceNameBuf, ) -> Result<(), RenameWorkspaceError>

pub fn add_head(&mut self, head_id: &CommitId)

pub fn remove_head(&mut self, head_id: &CommitId)

pub fn local_bookmarks(&self) -> impl Iterator<Item = (&RefName, &RefTarget)>

Iterates local bookmark (name, target)s in lexicographical order.

pub fn local_bookmarks_for_commit<'a, 'b>( &'a self, commit_id: &'b CommitId, ) -> impl Iterator<Item = (&'a RefName, &'a RefTarget)> + use<'a, 'b>

Iterates local bookmarks (name, target) in lexicographical order where the target adds commit_id.

pub fn local_bookmarks_matching<'a, 'b>( &'a self, pattern: &'b StringPattern, ) -> impl Iterator<Item = (&'a RefName, &'a RefTarget)> + use<'a, 'b>

Iterates local bookmark (name, target)s matching the given pattern. Entries are sorted by name.

pub fn get_local_bookmark(&self, name: &RefName) -> &RefTarget

pub fn set_local_bookmark_target(&mut self, name: &RefName, target: RefTarget)

Sets local bookmark to point to the given target. If the target is absent, and if no associated remote bookmarks exist, the bookmark will be removed.

pub fn all_remote_bookmarks( &self, ) -> impl Iterator<Item = (RemoteRefSymbol<'_>, &RemoteRef)>

Iterates over (symbol, remote_ref) for all remote bookmarks in lexicographical order.

pub fn remote_bookmarks( &self, remote_name: &RemoteName, ) -> impl Iterator<Item = (&RefName, &RemoteRef)> + use<'_>

Iterates over (name, remote_ref)s for all remote bookmarks of the specified remote in lexicographical order.

pub fn remote_bookmarks_matching<'a, 'b>( &'a self, bookmark_pattern: &'b StringPattern, remote_pattern: &'b StringPattern, ) -> impl Iterator<Item = (RemoteRefSymbol<'a>, &'a RemoteRef)> + use<'a, 'b>

Iterates over (symbol, remote_ref)s for all remote bookmarks of the specified remote that match the given pattern.

Entries are sorted by symbol, which is (name, remote).

pub fn get_remote_bookmark(&self, symbol: RemoteRefSymbol<'_>) -> &RemoteRef

pub fn set_remote_bookmark( &mut self, symbol: RemoteRefSymbol<'_>, remote_ref: RemoteRef, )

Sets remote-tracking bookmark to the given target and state. If the target is absent, the bookmark will be removed.

pub fn local_remote_bookmarks( &self, remote_name: &RemoteName, ) -> impl Iterator<Item = (&RefName, LocalAndRemoteRef<'_>)> + use<'_>

Iterates over (name, {local_ref, remote_ref})s for every bookmark present locally and/or on the specified remote, in lexicographical order.

Note that this does not take into account whether the local bookmark tracks the remote bookmark or not. Missing values are represented as RefTarget::absent_ref() or RemoteRef::absent_ref().

pub fn local_remote_bookmarks_matching<'a, 'b>( &'a self, bookmark_pattern: &'b StringPattern, remote_name: &RemoteName, ) -> impl Iterator<Item = (&'a RefName, LocalAndRemoteRef<'a>)> + use<'a, 'b>

Iterates over (name, TrackingRefPair {local_ref, remote_ref})s for every bookmark with a name that matches the given pattern, and that is present locally and/or on the specified remote.

Entries are sorted by name.

Note that this does not take into account whether the local bookmark tracks the remote bookmark or not. Missing values are represented as RefTarget::absent_ref() or RemoteRef::absent_ref().

pub fn remove_remote(&mut self, remote_name: &RemoteName)

pub fn rename_remote(&mut self, old: &RemoteName, new: &RemoteName)

pub fn get_tag(&self, name: &RefName) -> &RefTarget

pub fn tags_matching<'a, 'b>( &'a self, pattern: &'b StringPattern, ) -> impl Iterator<Item = (&'a RefName, &'a RefTarget)> + use<'a, 'b>

Iterates tags (name, target)s matching the given pattern. Entries are sorted by name.

pub fn set_tag_target(&mut self, name: &RefName, target: RefTarget)

Sets tag to point to the given target. If the target is absent, the tag will be removed.

pub fn get_git_ref(&self, name: &GitRefName) -> &RefTarget

pub fn set_git_ref_target(&mut self, name: &GitRefName, target: RefTarget)

Sets the last imported Git ref to point to the given target. If the target is absent, the reference will be removed.

pub fn set_git_head_target(&mut self, target: RefTarget)

Sets Git HEAD to point to the given target. If the target is absent, the reference will be cleared.

pub fn all_referenced_commit_ids(&self) -> impl Iterator<Item = &CommitId>

Iterates all commit ids referenced by this view.

This can include hidden commits referenced by remote bookmarks, previous positions of conflicted bookmarks, etc. The ancestors and predecessors of the returned commits should be considered reachable from the view. Use this to build commit index from scratch.

The iteration order is unspecified, and may include duplicated entries.

pub fn set_view(&mut self, data: View)

pub fn store_view(&self) -> &View

pub fn store_view_mut(&mut self) -> &mut View

Trait Implementations

impl Clone for View

fn clone(&self) -> View

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for View

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

Formats the value using the given formatter.

impl PartialEq for View

fn eq(&self, other: &View) -> 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 Eq for View

impl StructuralPartialEq for View