Struct GitRef 

pub struct GitRef {
    pub proc: Option<Arc<DaggerSessionProc>>,
    pub selection: Selection,
    pub graphql_client: DynGraphQLClient,
}

Fields

proc: Option<Arc<DaggerSessionProc>>

selection: Selection

graphql_client: DynGraphQLClient

Implementations

impl GitRef

pub fn as_repository(&self) -> GitRepository

Return this ref’s repository with HEAD pinned to the selected commit. Preserves the original repository backend, connection information, and other refs. Does not modify a branch or checkout, or prune history.

pub fn as_workspace(&self) -> Workspace

Creates a synthetic workspace from this git ref.

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

pub fn as_workspace_opts<'a>( &self, opts: GitRefAsWorkspaceOpts<'a>, ) -> Workspace

Creates a synthetic workspace from this git ref.

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

pub async fn commit(&self) -> Result<String, DaggerError>

The resolved commit id at this ref.

pub async fn commit_sha(&self) -> Result<String, DaggerError>

The resolved commit SHA at this ref.

pub fn common_ancestor(&self, other: impl IntoID<Id>) -> GitRef

Find the best common ancestor between this ref and another ref.

Arguments

• other - The other ref to compare against.

pub async fn id(&self) -> Result<Id, DaggerError>

A unique identifier for this GitRef.

pub async fn log(&self) -> Result<Vec<GitCommit>, DaggerError>

Commits reachable from this ref, newest first, starting with the commit this ref resolves to.

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

pub async fn log_opts<'a>( &self, opts: GitRefLogOpts<'a>, ) -> Result<Vec<GitCommit>, DaggerError>

Commits reachable from this ref, newest first, starting with the commit this ref resolves to.

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

pub async fn name(&self) -> Result<String, DaggerError>

The resolved name of this ref.

pub fn push(&self) -> GitPushResult

Push this ref’s commit and history to a remote repository using the destination’s credentials. The source can come from a remote repository or an engine-side Git repository. To publish a workspace’s commits, use Workspace.git.head.push. Pushing does not modify the calling client’s checkout, and checkout hooks do not run. A missing remote ref is created. Without a lease, Git’s normal non-force rules apply. Each invocation performs a push; loading the returned receipt does not push again.

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

pub fn push_opts<'a>(&self, opts: GitRefPushOpts<'a>) -> GitPushResult

Push this ref’s commit and history to a remote repository using the destination’s credentials. The source can come from a remote repository or an engine-side Git repository. To publish a workspace’s commits, use Workspace.git.head.push. Pushing does not modify the calling client’s checkout, and checkout hooks do not run. A missing remote ref is created. Without a lease, Git’s normal non-force rules apply. Each invocation performs a push; loading the returned receipt does not push again.

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

pub async fn ref(&self) -> Result<String, DaggerError>

The resolved ref name at this ref.

pub fn target_commit(&self) -> GitCommit

The commit this ref resolves to.

pub fn tree(&self) -> Directory

The filesystem tree at this ref.

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

pub fn tree_opts(&self, opts: GitRefTreeOpts) -> Directory

The filesystem tree at this ref.

Arguments

• opt - optional argument, see inner type for documentation, use _opts to use

pub fn with_commit( &self, changes: impl IntoID<Id>, message: impl Into<String>, date: impl Into<String>, author_name: impl Into<String>, author_email: impl Into<String>, ) -> GitRef

Create a single-parent commit on this ref by applying a changeset’s edits. Three-way merges the changeset against this ref’s tree, using its before snapshot as the base. Preserves compatible parent edits and fails on conflicts. Does not modify the input repository or host checkout. Identity and dates are explicit; neither client Git configuration nor the current clock is consulted.

Arguments

• changes - Changes to apply. Use Changeset.filter to select paths before committing.
• message - Commit message.
• date - RFC3339 author date; also the default committer date.
• author_name - Author name.
• author_email - Author email.
• opt - optional argument, see inner type for documentation, use _opts to use

pub fn with_commit_opts<'a>( &self, changes: impl IntoID<Id>, message: impl Into<String>, date: impl Into<String>, author_name: impl Into<String>, author_email: impl Into<String>, opts: GitRefWithCommitOpts<'a>, ) -> GitRef

Create a single-parent commit on this ref by applying a changeset’s edits. Three-way merges the changeset against this ref’s tree, using its before snapshot as the base. Preserves compatible parent edits and fails on conflicts. Does not modify the input repository or host checkout. Identity and dates are explicit; neither client Git configuration nor the current clock is consulted.

Arguments

• changes - Changes to apply. Use Changeset.filter to select paths before committing.
• message - Commit message.
• date - RFC3339 author date; also the default committer date.
• author_name - Author name.
• author_email - Author email.
• opt - optional argument, see inner type for documentation, use _opts to use

Trait Implementations

impl Clone for GitRef

fn clone(&self) -> GitRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl IntoID<Id> for GitRef

fn into_id( self, ) -> Pin<Box<dyn Future<Output = Result<Id, DaggerError>> + Send>>

impl Loadable for GitRef

fn graphql_type() -> &'static str

The GraphQL type name (e.g. "Container").

fn from_query( proc: Option<Arc<DaggerSessionProc>>, selection: Selection, graphql_client: DynGraphQLClient, ) -> Self

Construct this type from a query selection.

impl Node for GitRef

fn id(&self) -> impl Future<Output = Result<Id, DaggerError>> + Send