Struct GetFileInput

#[non_exhaustive]
pub struct GetFileInput {
    pub repository_name: Option<String>,
    pub commit_specifier: Option<String>,
    pub file_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 that contains the file.

commit_specifier: Option<String>

The fully quaified reference that identifies the commit that contains the file. For example, you can specify a full commit ID, a tag, a branch name, or a reference such as refs/heads/main. If none is provided, the head commit is used.

file_path: Option<String>

The fully qualified path to the file, including the full name and extension of the file. For example, /examples/file.md is the fully qualified path to a file named file.md in a folder named examples.

Implementations

impl GetFileInput

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

The name of the repository that contains the file.

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

The fully quaified reference that identifies the commit that contains the file. For example, you can specify a full commit ID, a tag, a branch name, or a reference such as refs/heads/main. If none is provided, the head commit is used.

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

The fully qualified path to the file, including the full name and extension of the file. For example, /examples/file.md is the fully qualified path to a file named file.md in a folder named examples.

impl GetFileInput

pub fn builder() -> GetFileInputBuilder

Creates a new builder-style object to manufacture GetFileInput.

Trait Implementations

impl Clone for GetFileInput

fn clone(&self) -> GetFileInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetFileInput

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

Formats the value using the given formatter.

impl PartialEq for GetFileInput

fn eq(&self, other: &GetFileInput) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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 GetFileInput