Struct radicle_surf::fs::Submodule

pub struct Submodule { /* private fields */ }

A representation of a Git submodule when encountered in a Git repository.

Implementations

impl Submodule

pub fn new( name: String, prefix: PathBuf, submodule: Option<Submodule<'_>>, id: Oid, ) -> Result<Self, Submodule>

Construct a new Submodule.

The path must be the prefix location of the directory, and so should not end in name.

The id is the commit pointer that Git provides when listing a submodule.

pub fn name(&self) -> &String

The name of this Submodule.

Examples found in repository

examples/browsing.rs (line 58)

fn print_directory(d: &Directory, repo: &Repository, indent_level: usize) {
    let indent = " ".repeat(indent_level * 4);
    println!("{}{}/", &indent, d.name());
    for entry in d.entries(repo).unwrap() {
        match entry {
            fs::Entry::File(f) => println!("    {}{}", &indent, f.name()),
            fs::Entry::Directory(d) => print_directory(&d, repo, indent_level + 1),
            fs::Entry::Submodule(s) => println!("    {}{}", &indent, s.name()),
        }
    }
}

pub fn location(&self) -> &Path

Return the Path where this Submodule is located, relative to the git repository root.

pub fn path(&self) -> PathBuf

Return the exact path for this Submodule, including the name of the submodule itself.

The path is relative to the git repository root.

pub fn id(&self) -> Oid

The object identifier of this Submodule.

Note that this does not exist in the parent Repository. A new Repository should be opened for the submodule.

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

The URL for the submodule, if it is defined.

Trait Implementations

impl Clone for Submodule

fn clone(&self) -> Submodule

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Submodule

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

Formats the value using the given formatter.

impl PartialEq for Submodule

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

impl StructuralPartialEq for Submodule