Struct SubmoduleContext

pub struct SubmoduleContext<'a> {
    pub name: Cow<'a, str>,
    pub path: Cow<'a, str>,
    pub url: Cow<'a, str>,
    pub branch: Cow<'a, str>,
    pub context: GitContext,
}

A git context for a submodule for use within checks.

Checks which need to inspect submodules should use this to obtain a GitContext for the submodule.

Fields

name: Cow<'a, str>

The name of the submodule (usually the same as path).

path: Cow<'a, str>

The path of the submodule within the repository.

url: Cow<'a, str>

The clone URL for the submodule.

branch: Cow<'a, str>

The branch the submodule tracks.

context: GitContext

The context to use to query the submodule.

Implementations

impl<'a> SubmoduleContext<'a>

pub fn new(ctx: &'a CheckGitContext, diff_path: &str) -> Option<Self>

Create submodule context for the given path.

Returns None if the requisite information is not available within the context being used.

Trait Implementations

impl<'a> Debug for SubmoduleContext<'a>

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

Formats the value using the given formatter.