Struct branchless::core::dag::Dag

source ·

pub struct Dag {
    pub head_commit: CommitSet,
    pub main_branch_commit: CommitSet,
    pub branch_commits: CommitSet,
    /* private fields */
}

Expand description

Interface to access the directed acyclic graph (DAG) representing Git’s commit graph. Based on the Eden SCM DAG.

Fields

head_commit: CommitSet

A set containing the commit which HEAD points to. If HEAD is unborn, this is an empty set.

main_branch_commit: CommitSet

A set containing the commit that the main branch currently points to.

branch_commits: CommitSet

A set containing all commits currently pointed to by local branches.

Implementations

source

impl Dag

source

pub fn open_and_sync(
 effects: &Effects,
 repo: &Repo,
 event_replayer: &EventReplayer,
 event_cursor: EventCursor,
 references_snapshot: &RepoReferencesSnapshot
) -> Result<Self>

Initialize the DAG for the given repository, and update it with any newly-referenced commits.

source

pub fn open_without_syncing(
 effects: &Effects,
 repo: &Repo,
 event_replayer: &EventReplayer,
 event_cursor: EventCursor,
 references_snapshot: &RepoReferencesSnapshot
) -> Result<Self>

Initialize a DAG for the given repository, without updating it with new commits that may have appeared.

If used improperly, commit lookups could fail at runtime. This function should only be used for opening the DAG when it’s known that no more live commits have appeared.

source

pub fn sync_from_oids(
 &mut self,
 effects: &Effects,
 repo: &Repo,
 master_heads: CommitSet,
 non_master_heads: CommitSet
) -> Result<()>

Update the DAG with the given heads.

source

pub fn set_cursor(
 &self,
 effects: &Effects,
 repo: &Repo,
 event_replayer: &EventReplayer,
 event_cursor: EventCursor
) -> Result<Self>

Create a new version of this DAG at the point in time represented by event_cursor.

source

pub fn clear_obsolete_commits(&self, repo: &Repo) -> Result<Self>

Create a new Dag with no obsolete commits.

source

pub fn get_only_parent_oid(&self, oid: NonZeroOid) -> Result<NonZeroOid>

Get the parent OID for the given OID. Returns an error if the given OID does not have exactly 1 parent.

source

pub fn get_range(
 &self,
 effects: &Effects,
 repo: &Repo,
 parent_oid: NonZeroOid,
 child_oid: NonZeroOid
) -> Result<Vec<NonZeroOid>>

Get the range of OIDs from parent_oid to child_oid. Note that there may be more than one path; in that case, the OIDs are returned in a topologically-sorted order.

source

pub fn query(&self) -> &Dag

Conduct an arbitrary query against the DAG.

source

pub fn is_public_commit(&self, commit_oid: NonZeroOid) -> Result<bool>

Determine whether or not the given commit is a public commit (i.e. is an ancestor of the main branch).

source

pub fn query_public_commits_slow(&self) -> Result<&CommitSet>

Return the set of commits which are public, as per the definition in is_public_commit. You should try to use is_public_commit instead, as it will be faster to compute.

source

pub fn query_visible_heads(&self) -> Result<&CommitSet>

Determine the set of commits which are considered to be “visible”. A commit is “visible” if it is not obsolete or has a non-obsolete descendant.

source

pub fn query_visible_commits_slow(&self) -> Result<&CommitSet>

Query the set of all visible commits, as per the definition in query_visible_heads. You should try to use query_visible_heads instead if possible, since it will be faster to compute.

source

pub fn filter_visible_commits(&self, commits: CommitSet) -> Result<CommitSet>

Keep only commits in the given set which are visible, as per the definition in query_visible_heads.

source

pub fn query_obsolete_commits(&self) -> CommitSet

Determine the set of obsolete commits. These commits have been rewritten or explicitly hidden by the user.

source

pub fn query_draft_commits(&self) -> Result<&CommitSet>

Determine the set of “draft” commits. The draft commits are all visible commits which aren’t public.

source

pub fn get_connected_components(
&self,
commit_set: &CommitSet
) -> Result<Vec<CommitSet>>

Given a CommitSet, return a list of CommitSets, each representing a connected component of the set.

For example, if the DAG contains commits A-B-C-D-E-F and the given CommitSet contains B, C, E, this will return 2 CommitSets: 1 containing B, C and another containing only E

Trait Implementations

source

impl Debug for Dag

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl Send for Dag

impl Sync for Dag

impl Unpin for Dag

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,

Set the foreground color generically Read more

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,

Set the background color generically. Read more

fn black<'a>(&'a self) -> FgColorDisplay<'a, Black, Self>

Change the foreground color to black

fn on_black<'a>(&'a self) -> BgColorDisplay<'a, Black, Self>

Change the background color to black

fn red<'a>(&'a self) -> FgColorDisplay<'a, Red, Self>

Change the foreground color to red

fn on_red<'a>(&'a self) -> BgColorDisplay<'a, Red, Self>

Change the background color to red

fn green<'a>(&'a self) -> FgColorDisplay<'a, Green, Self>

Change the foreground color to green

fn on_green<'a>(&'a self) -> BgColorDisplay<'a, Green, Self>

Change the background color to green

fn yellow<'a>(&'a self) -> FgColorDisplay<'a, Yellow, Self>

Change the foreground color to yellow

fn on_yellow<'a>(&'a self) -> BgColorDisplay<'a, Yellow, Self>

Change the background color to yellow

fn blue<'a>(&'a self) -> FgColorDisplay<'a, Blue, Self>

Change the foreground color to blue

fn on_blue<'a>(&'a self) -> BgColorDisplay<'a, Blue, Self>

Change the background color to blue

fn magenta<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to magenta

fn on_magenta<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the background color to magenta

fn purple<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to purple

fn on_purple<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the background color to purple

fn cyan<'a>(&'a self) -> FgColorDisplay<'a, Cyan, Self>

Change the foreground color to cyan

fn on_cyan<'a>(&'a self) -> BgColorDisplay<'a, Cyan, Self>

Change the background color to cyan

fn white<'a>(&'a self) -> FgColorDisplay<'a, White, Self>

Change the foreground color to white

fn on_white<'a>(&'a self) -> BgColorDisplay<'a, White, Self>

Change the background color to white

fn default_color<'a>(&'a self) -> FgColorDisplay<'a, Default, Self>

Change the foreground color to the terminal default

fn on_default_color<'a>(&'a self) -> BgColorDisplay<'a, Default, Self>

Change the background color to the terminal default

fn bright_black<'a>(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>

Change the foreground color to bright black

fn on_bright_black<'a>(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>

Change the background color to bright black

fn bright_red<'a>(&'a self) -> FgColorDisplay<'a, BrightRed, Self>

Change the foreground color to bright red

fn on_bright_red<'a>(&'a self) -> BgColorDisplay<'a, BrightRed, Self>

Change the background color to bright red

fn bright_green<'a>(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>

Change the foreground color to bright green

fn on_bright_green<'a>(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>

Change the background color to bright green

fn bright_yellow<'a>(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>

Change the foreground color to bright yellow

fn on_bright_yellow<'a>(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>

Change the background color to bright yellow

fn bright_blue<'a>(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>

Change the foreground color to bright blue

fn on_bright_blue<'a>(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>

Change the background color to bright blue

fn bright_magenta<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright magenta

fn on_bright_magenta<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the background color to bright magenta

fn bright_purple<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright purple

fn on_bright_purple<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the background color to bright purple

fn bright_cyan<'a>(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>

Change the foreground color to bright cyan

fn on_bright_cyan<'a>(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>

Change the background color to bright cyan

fn bright_white<'a>(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>

Change the foreground color to bright white

fn on_bright_white<'a>(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>

Change the background color to bright white

fn bold<'a>(&'a self) -> BoldDisplay<'a, Self>

Make the text bold

fn dimmed<'a>(&'a self) -> DimDisplay<'a, Self>

Make the text dim

fn italic<'a>(&'a self) -> ItalicDisplay<'a, Self>

Make the text italicized

fn underline<'a>(&'a self) -> UnderlineDisplay<'a, Self>

Make the text italicized

fn blink<'a>(&'a self) -> BlinkDisplay<'a, Self>

Make the text blink

fn blink_fast<'a>(&'a self) -> BlinkFastDisplay<'a, Self>

Make the text blink (but fast!)

fn reversed<'a>(&'a self) -> ReversedDisplay<'a, Self>

Swap the foreground and background colors

fn hidden<'a>(&'a self) -> HiddenDisplay<'a, Self>

Hide the text

fn strikethrough<'a>(&'a self) -> StrikeThroughDisplay<'a, Self>

Cross out the text

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more

fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.

fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> With for T

fn wrap_with<U, F>(self, f: F) -> Uwhere
F: FnOnce(Self) -> U,

Calls the given closure and return the result. Read more

fn with<F>(self, f: F) -> Selfwhere
F: FnOnce(&mut Self),

Calls the given closure on self.

fn try_with<E, F>(self, f: F) -> Result<Self, E>where
F: FnOnce(&mut Self) -> Result<(), E>,

Calls the given closure on self.

fn with_if<F>(self, condition: bool, f: F) -> Selfwhere
F: FnOnce(&mut Self),

Calls the given closure if condition == true.

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct branchless::core::dag::Dag

Fields

Implementations

impl Dag

pub fn open_and_sync( effects: &Effects, repo: &Repo, event_replayer: &EventReplayer, event_cursor: EventCursor, references_snapshot: &RepoReferencesSnapshot) -> Result<Self>

pub fn open_without_syncing( effects: &Effects, repo: &Repo, event_replayer: &EventReplayer, event_cursor: EventCursor, references_snapshot: &RepoReferencesSnapshot) -> Result<Self>

pub fn sync_from_oids( &mut self, effects: &Effects, repo: &Repo, master_heads: CommitSet, non_master_heads: CommitSet) -> Result<()>

pub fn set_cursor( &self, effects: &Effects, repo: &Repo, event_replayer: &EventReplayer, event_cursor: EventCursor) -> Result<Self>

pub fn clear_obsolete_commits(&self, repo: &Repo) -> Result<Self>

pub fn get_only_parent_oid(&self, oid: NonZeroOid) -> Result<NonZeroOid>

pub fn get_range( &self, effects: &Effects, repo: &Repo, parent_oid: NonZeroOid, child_oid: NonZeroOid) -> Result<Vec<NonZeroOid>>

pub fn query(&self) -> &Dag

pub fn is_public_commit(&self, commit_oid: NonZeroOid) -> Result<bool>

pub fn query_public_commits_slow(&self) -> Result<&CommitSet>

pub fn query_visible_heads(&self) -> Result<&CommitSet>

pub fn query_visible_commits_slow(&self) -> Result<&CommitSet>

pub fn filter_visible_commits(&self, commits: CommitSet) -> Result<CommitSet>

pub fn query_obsolete_commits(&self) -> CommitSet

pub fn query_draft_commits(&self) -> Result<&CommitSet>

pub fn get_connected_components( &self, commit_set: &CommitSet) -> Result<Vec<CommitSet>>

Trait Implementations

impl Debug for Dag

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

Auto Trait Implementations

impl !RefUnwindSafe for Dag

impl Send for Dag

impl Sync for Dag

impl Unpin for Dag

impl !UnwindSafe for Dag

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where C: Color,

fn black<'a>(&'a self) -> FgColorDisplay<'a, Black, Self>

fn on_black<'a>(&'a self) -> BgColorDisplay<'a, Black, Self>

fn red<'a>(&'a self) -> FgColorDisplay<'a, Red, Self>

fn on_red<'a>(&'a self) -> BgColorDisplay<'a, Red, Self>

fn green<'a>(&'a self) -> FgColorDisplay<'a, Green, Self>

fn on_green<'a>(&'a self) -> BgColorDisplay<'a, Green, Self>

fn yellow<'a>(&'a self) -> FgColorDisplay<'a, Yellow, Self>

fn on_yellow<'a>(&'a self) -> BgColorDisplay<'a, Yellow, Self>

fn blue<'a>(&'a self) -> FgColorDisplay<'a, Blue, Self>

fn on_blue<'a>(&'a self) -> BgColorDisplay<'a, Blue, Self>

fn magenta<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

fn on_magenta<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

fn purple<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

fn on_purple<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

fn cyan<'a>(&'a self) -> FgColorDisplay<'a, Cyan, Self>

fn on_cyan<'a>(&'a self) -> BgColorDisplay<'a, Cyan, Self>

fn white<'a>(&'a self) -> FgColorDisplay<'a, White, Self>

fn on_white<'a>(&'a self) -> BgColorDisplay<'a, White, Self>

fn default_color<'a>(&'a self) -> FgColorDisplay<'a, Default, Self>

fn on_default_color<'a>(&'a self) -> BgColorDisplay<'a, Default, Self>

fn bright_black<'a>(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>

fn on_bright_black<'a>(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>

fn bright_red<'a>(&'a self) -> FgColorDisplay<'a, BrightRed, Self>

fn on_bright_red<'a>(&'a self) -> BgColorDisplay<'a, BrightRed, Self>

fn bright_green<'a>(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>

fn on_bright_green<'a>(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>

fn bright_yellow<'a>(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>

fn on_bright_yellow<'a>(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>

fn bright_blue<'a>(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>

fn on_bright_blue<'a>(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>

fn bright_magenta<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

fn on_bright_magenta<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

fn bright_purple<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

fn on_bright_purple<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

pub fn open_and_sync(
effects: &Effects,
repo: &Repo,
event_replayer: &EventReplayer,
event_cursor: EventCursor,
references_snapshot: &RepoReferencesSnapshot
) -> Result<Self>

pub fn open_without_syncing(
effects: &Effects,
repo: &Repo,
event_replayer: &EventReplayer,
event_cursor: EventCursor,
references_snapshot: &RepoReferencesSnapshot
) -> Result<Self>

pub fn sync_from_oids(
&mut self,
effects: &Effects,
repo: &Repo,
master_heads: CommitSet,
non_master_heads: CommitSet
) -> Result<()>

pub fn set_cursor(
&self,
effects: &Effects,
repo: &Repo,
event_replayer: &EventReplayer,
event_cursor: EventCursor
) -> Result<Self>

pub fn get_range(
&self,
effects: &Effects,
repo: &Repo,
parent_oid: NonZeroOid,
child_oid: NonZeroOid
) -> Result<Vec<NonZeroOid>>

pub fn get_connected_components(
&self,
commit_set: &CommitSet
) -> Result<Vec<CommitSet>>

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,

fn fg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

fn bg_rgb<const R: u8, const G: u8, const B: u8>(
&self
) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn wrap_with<U, F>(self, f: F) -> Uwhere
F: FnOnce(Self) -> U,

fn with<F>(self, f: F) -> Selfwhere
F: FnOnce(&mut Self),

fn try_with<E, F>(self, f: F) -> Result<Self, E>where
F: FnOnce(&mut Self) -> Result<(), E>,

fn with_if<F>(self, condition: bool, f: F) -> Selfwhere
F: FnOnce(&mut Self),

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,