Struct git2::Submodule

pub struct Submodule<'repo> { /* fields omitted */ }

A structure to represent a git submodule

Implementations

impl<'repo> Submodule<'repo>

pub fn branch(&self) -> Option<&str>

Get the submodule’s branch.

Returns None if the branch is not valid utf-8 or if the branch is not yet available.

pub fn branch_bytes(&self) -> Option<&[u8]>

Get the branch for the submodule.

Returns None if the branch is not yet available.

pub fn clone(
    &mut self,
    opts: Option<&mut SubmoduleUpdateOptions<'_>>
) -> Result<Repository, Error>

Perform the clone step for a newly created submodule.

This performs the necessary git_clone to setup a newly-created submodule.

pub fn url(&self) -> Option<&str>

Get the submodule’s url.

Returns None if the url is not valid utf-8 or if the URL isn’t present

pub fn opt_url_bytes(&self) -> Option<&[u8]>

Get the url for the submodule.

Returns None if the URL isn’t present

pub fn name(&self) -> Option<&str>

Get the submodule’s name.

Returns None if the name is not valid utf-8

pub fn name_bytes(&self) -> &[u8]

Get the name for the submodule.

pub fn path(&self) -> &Path

Get the path for the submodule.

pub fn head_id(&self) -> Option<Oid>

Get the OID for the submodule in the current HEAD tree.

pub fn index_id(&self) -> Option<Oid>

Get the OID for the submodule in the index.

pub fn workdir_id(&self) -> Option<Oid>

Get the OID for the submodule in the current working directory.

This returns the OID that corresponds to looking up ‘HEAD’ in the checked out submodule. If there are pending changes in the index or anything else, this won’t notice that.

pub fn ignore_rule(&self) -> SubmoduleIgnore

Get the ignore rule that will be used for the submodule.

pub fn update_strategy(&self) -> SubmoduleUpdate

Get the update rule that will be used for the submodule.

pub fn init(&mut self, overwrite: bool) -> Result<(), Error>

Copy submodule info into “.git/config” file.

Just like “git submodule init”, this copies information about the submodule into “.git/config”. You can use the accessor functions above to alter the in-memory git_submodule object and control what is written to the config, overriding what is in .gitmodules.

By default, existing entries will not be overwritten, but passing true for overwrite forces them to be updated.

pub fn open(&self) -> Result<Repository, Error>

Open the repository for a submodule.

This will only work if the submodule is checked out into the working directory.

pub fn reload(&mut self, force: bool) -> Result<(), Error>

Reread submodule info from config, index, and HEAD.

Call this to reread cached submodule information for this submodule if you have reason to believe that it has changed.

If force is true, then data will be reloaded even if it doesn’t seem out of date

pub fn sync(&mut self) -> Result<(), Error>

Copy submodule remote info into submodule repo.

This copies the information about the submodules URL into the checked out submodule config, acting like “git submodule sync”. This is useful if you have altered the URL for the submodule (or it has been altered by a fetch of upstream changes) and you need to update your local repo.

pub fn add_to_index(&mut self, write_index: bool) -> Result<(), Error>

Add current submodule HEAD commit to index of superproject.

If write_index is true, then the index file will be immediately written. Otherwise you must explicitly call write() on an Index later on.

pub fn add_finalize(&mut self) -> Result<(), Error>

Resolve the setup of a new git submodule.

This should be called on a submodule once you have called add setup and done the clone of the submodule. This adds the .gitmodules file and the newly cloned submodule to the index to be ready to be committed (but doesn’t actually do the commit).

pub fn update(
    &mut self,
    init: bool,
    opts: Option<&mut SubmoduleUpdateOptions<'_>>
) -> Result<(), Error>

Update submodule.

This will clone a missing submodule and check out the subrepository to the commit specified in the index of the containing repository. If the submodule repository doesn’t contain the target commit, then the submodule is fetched using the fetch options supplied in opts.

init indicates if the submodule should be initialized first if it has not been initialized yet.

Trait Implementations

impl<'repo> Drop for Submodule<'repo>

fn drop(&mut self)

Executes the destructor for this type.