Struct GitContext 

pub struct GitContext {
    pub branch: Option<String>,
    pub head: Option<String>,
    pub working_tree: String,
    pub commits: Vec<CommitReference>,
}

The head this answer was compiled against. A compiled context is only true of one tree, and these three fields plus the index fingerprint are what say which.

branch and head are optional because a checkout can legitimately have neither — a detached head, or a tree that is not a git repository at all — and the absence is carried rather than faked. working_tree is not optional, because there is always something to say: when git cannot be reached it carries unavailable: <reason> instead of a status, so a reader is never left unable to tell “clean” from “not asked”.

commits is derived from the selected entries’ own records and never from a log walk. That is the difference between “the commits this work says it produced” and “what happened to be committed recently”, and only the first is context.

use majordomus_cli::devcontext::GitContext;
use serde_json::json;

// a tree the compiler could read
let known: GitContext = serde_json::from_value(json!({
    "branch": "master",
    "head": "cd04012f1b1dc21fd493e2be14938ffdfaccc8fa",
    "working_tree": "clean",
})).unwrap();
assert_eq!(known.branch.as_deref(), Some("master"));
assert!(known.commits.is_empty(), "no selected record named a commit");

// and one it could not: the status field still says something a reader can act on
let unknown: GitContext = serde_json::from_value(json!({
    "working_tree": "unavailable: not a git repository",
})).unwrap();
assert!(unknown.head.is_none() && unknown.branch.is_none());
assert!(
    unknown.working_tree.starts_with("unavailable: "),
    "never silently indistinguishable from clean",
);

Fields

branch: Option<String>

The branch, when the checkout is on one.

head: Option<String>

The head commit.

working_tree: String

clean, dirty, or what git said.

commits: Vec<CommitReference>

Commits the selected entries name as their own evidence, newest record first. Derived from the layer’s records, never from a log walk.

Trait Implementations

impl Clone for GitContext

fn clone(&self) -> GitContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitContext

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GitContext

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for GitContext

impl JsonSchema for GitContext

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for GitContext

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GitContext