Struct radicle_surf::fs::File

pub struct File { /* private fields */ }

A File in a git repository.

The representation is lightweight and contains the Oid that points to the git blob which is this file.

The name of a file can be retrieved via File::name.

The FileContent of a file can be retrieved via File::content.

Implementations

impl File

pub fn name(&self) -> &str

The name of this File.

Examples found in repository

examples/browsing.rs (line 56)

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 id(&self) -> Oid

The object identifier of this File.

pub fn path(&self) -> PathBuf

Return the exact path for this File, including the name of the directory itself.

The path is relative to the git repository root.

pub fn location(&self) -> &Path

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

pub fn content<'a>(&self, repo: &'a Repository) -> Result<FileContent<'a>, File>

Get the FileContent for this File.

Errors

This function will fail if it could not find the git blob for the Oid of this File.

Trait Implementations

impl Clone for File

fn clone(&self) -> File

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for File

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

Formats the value using the given formatter.

impl PartialEq for File

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

impl StructuralPartialEq for File