Struct GetFolderInput 

#[non_exhaustive]
pub struct GetFolderInput {
    pub repository_name: Option<String>,
    pub commit_specifier: Option<String>,
    pub folder_path: Option<String>,
}

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.

repository_name: Option<String>

The name of the repository.

commit_specifier: Option<String>

A fully qualified reference used to identify a commit that contains the version of the folder's content to return. A fully qualified reference can be a commit ID, branch name, tag, or reference such as HEAD. If no specifier is provided, the folder content is returned as it exists in the HEAD commit.

folder_path: Option<String>

The fully qualified path to the folder whose contents are returned, including the folder name. For example, /examples is a fully-qualified path to a folder named examples that was created off of the root directory (/) of a repository.

Implementations

impl GetFolderInput

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

The name of the repository.

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

A fully qualified reference used to identify a commit that contains the version of the folder's content to return. A fully qualified reference can be a commit ID, branch name, tag, or reference such as HEAD. If no specifier is provided, the folder content is returned as it exists in the HEAD commit.

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

The fully qualified path to the folder whose contents are returned, including the folder name. For example, /examples is a fully-qualified path to a folder named examples that was created off of the root directory (/) of a repository.

impl GetFolderInput

pub fn builder() -> GetFolderInputBuilder

Creates a new builder-style object to manufacture GetFolderInput.

Trait Implementations

impl Clone for GetFolderInput

fn clone(&self) -> GetFolderInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetFolderInput

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

Formats the value using the given formatter.

impl PartialEq for GetFolderInput

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