Struct SourceTree 

pub struct SourceTree {
    pub path: PathBuf,
    pub mode: String,
    pub sha: String,
    pub entry_type: TreeEntryType,
    pub size: u32,
    pub url: String,
    pub children: Vec<SourceTree>,
}

A tree representing the directories and files of a GitHub repo.

Fields

path: PathBuf

The path of the file relative to the root of the repository.

mode: String

The unix permissions mode of the file, in numeric notation.

sha: String

The SHA1 hash identifying this blob or tree.

This is NOT the same as the sha1 hash of the contents.

entry_type: TreeEntryType

The type of the entry.

size: u32

The size of the entry in bytes, or 0 for blob entries.

url: String

The API URL to call to get more information on this object.

• For TreeEntryType::Blob, this is the URL of the Get a blob API call for this entry.
• For TreeEntryType::Tree, this is the URL of the Get a tree API call for this entry.

children: Vec<SourceTree>

The children of this entry, if any.

Implementations

impl SourceTree

pub fn new(entry_type: TreeEntryType) -> SourceTree

Create a new empty SourceTree with the given TreeEntryType.

pub async fn get<'p>( path: &'p GithubBranchPath<'p>, ) -> Result<SourceTree, Error>

Obtain the entire SourceTree for a given GithubBranchPath.

pub fn resolve_blob(&self, path: &Path) -> Option<&SourceTree>

Walks the tree to find a blob at the given path, if any. Equivalent to resolve with find_blob as Some(true).

pub fn resolve_tree(&self, path: &Path) -> Option<&SourceTree>

Walks the tree to find a tree (directory) at the given path, if any. Equivalent to resolve with find_blob as Some(false).

pub fn resolve_any(&self, path: &Path) -> Option<&SourceTree>

Walks the tree to find a node at the given path, if any. Equivalent to resolve with find_blob as None.

pub fn resolve( &self, path: &Path, find_blob: Option<bool>, ) -> Option<&SourceTree>

Walks the tree to find an entry at the given path, if any.

• If find_blob is Some(true), only blob entries will be returned.
• If find_blob is Some(false), only tree entries will be returned.
• If find_blob is None, the first type of entry found will be returned.

pub fn iter<'tree>(&'tree self) -> SourceTreeIterator<'tree>

Creates a SourceTreeIterator that will walk down this tree and return a pointer for each node found.

pub fn prune( &self, predicate: for<'a> fn(&'a &SourceTree) -> bool, ) -> SourceTree

Creates a new SourceTree from this tree, only including child nodes where f returns true.

Trait Implementations

impl Clone for SourceTree

fn clone(&self) -> SourceTree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceTree

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

Formats the value using the given formatter.

impl PartialEq for SourceTree

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