Struct SparseCheckout 

pub struct SparseCheckout { /* private fields */ }

Sparse checkout manager for git repositories.

Implementations

impl SparseCheckout

pub fn init(repo_path: impl AsRef<Path>) -> Result<Self>

Initialize sparse checkout in an existing repository.

pub fn clone(url: &str, target: impl AsRef<Path>) -> Result<Self>

Clone a repository with sparse checkout enabled.

pub fn clone_shallow( url: &str, target: impl AsRef<Path>, depth: u32, ) -> Result<Self>

Clone with depth limit for faster initial clone.

pub fn open(repo_path: impl AsRef<Path>) -> Result<Self>

Open an existing sparse checkout repository.

pub fn path(&self) -> &Path

Get the repository path.

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

Get the remote URL.

pub fn add_paths(&self, paths: &[&str]) -> Result<()>

Add paths to the sparse checkout.

pub fn set_paths(&self, paths: &[&str]) -> Result<()>

Set the sparse checkout paths (replaces existing).

pub fn add_filter(&self, filter: &SparseFilter) -> Result<()>

Add a filter to the sparse checkout.

pub fn set_filters(&self, filters: &[SparseFilter]) -> Result<()>

Set filters for the sparse checkout (replaces existing).

pub fn list_patterns(&self) -> Result<Vec<String>>

List current sparse checkout patterns.

pub fn checkout(&self) -> Result<()>

Checkout the sparse files.

pub fn checkout_ref(&self, reference: &str) -> Result<()>

Checkout a specific branch or tag.

pub fn fetch(&self) -> Result<()>

Fetch updates from remote.

pub fn pull(&self) -> Result<()>

Pull updates (fetch + checkout).

pub fn disable(&self) -> Result<()>

Disable sparse checkout (get all files).

pub fn reapply(&self) -> Result<()>

Re-enable sparse checkout.

pub fn status(&self) -> Result<SparseStatus>

Get status of sparse checkout.

Trait Implementations

impl Debug for SparseCheckout

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

Formats the value using the given formatter.