Struct SubmoduleUpdate 

#[non_exhaustive]
pub struct SubmoduleUpdate {
    pub init: bool,
    pub recursive: bool,
    pub depth: Option<u32>,
    pub paths: Vec<String>,
}

A git submodule update specification — checks out the submodules recorded in the superproject’s index to the commits it pins, optionally initializing (--init) and recursing (--recursive) first, and optionally scoped to specific paths. Built fluently; see GitApi::submodule_update.

This is the one submodule verb that materializes and executes a different (nested) repository’s content — with init, it clones/fetches each submodule from the URL its .gitmodules records and checks out its working tree. Treat those nested repos with the same untrusted-repo caution as the superproject; see the submodules section of the security guide.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

init: bool

Initialize (register + clone) submodules not yet set up (--init).

recursive: bool

Recurse into nested submodules (--recursive).

depth: Option<u32>

Create a shallow clone with this history depth (--depth <n>); None leaves the depth unset (full history).

paths: Vec<String>

Restrict the update to these repo-relative submodule paths; empty means every submodule. Passed after a -- terminator so a path can never be parsed as a flag.

Implementations

impl SubmoduleUpdate

pub fn new() -> Self

A plain update (no --init/--recursive/--depth, all submodules).

pub fn init(self) -> Self

Register and clone submodules that are not yet initialized (--init).

pub fn recursive(self) -> Self

Recurse into nested submodules (--recursive).

pub fn depth(self, depth: u32) -> Self

Make a shallow checkout with history depth (--depth <n>).

pub fn path(self, path: impl Into<String>) -> Self

Scope the update to one submodule path (repeatable). With no path set, the update covers every submodule.

pub fn paths(self, paths: impl IntoIterator<Item = impl Into<String>>) -> Self

Scope the update to several submodule paths (appended to any already set).

Trait Implementations

impl Clone for SubmoduleUpdate

fn clone(&self) -> SubmoduleUpdate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubmoduleUpdate

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

Formats the value using the given formatter.

impl Default for SubmoduleUpdate

fn default() -> SubmoduleUpdate

Returns the “default value” for a type.

impl Eq for SubmoduleUpdate

impl PartialEq for SubmoduleUpdate

fn eq(&self, other: &SubmoduleUpdate) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for SubmoduleUpdate