Struct gitea_sdk::api::repos::commits::GetCommitsBuilder

pub struct GetCommitsBuilder {
    pub sha: Option<String>,
    pub path: Option<String>,
    pub stat: Option<bool>,
    pub verification: Option<bool>,
    pub files: Option<bool>,
    pub page: Option<i64>,
    pub limit: Option<i64>,
    pub not: Option<String>,
    /* private fields */
}

Options for getting a list of commits from a repository. All fields are optional.

Fields

sha: Option<String>

SHA or branch to start listing commits from (usually the default branch).

path: Option<String>

File path to a file/directory in the repository. If provided, only commits affecting this path will be returned.

stat: Option<bool>

Whether to include the stat field in the response. Disable to speed-up the response. Defaults to true. NOTE: Commit verification is not implemented yet, so this setting does nothing.

verification: Option<bool>

Whether to include the verification field in the response. Disable to speed-up the response. Defaults to true. NOTE: Commit verification is not implemented yet, so this setting does nothing.

files: Option<bool>

Whether to include the files field in the response. Disable to speed-up the response. Defaults to true. NOTE: Commit verification is not implemented yet, so this setting does nothing.

page: Option<i64>

Optional page number of the results to fetch (1-based). Defaults to 1 if not set.

limit: Option<i64>

Optional number of commits to return per page (page-size). Defaults to the maximum your instance allows if not set.

not: Option<String>

Commits that match the given specifier will not be listed.

Implementations

impl GetCommitsBuilder

pub fn sha(self, sha: impl Into<String>) -> Self

SHA or branch to start listing commits from (usually the default branch).

pub fn path(self, path: impl Into<String>) -> Self

File path to a file/directory in the repository. If provided, only commits affecting this path will be returned.

pub fn stat(self, stat: impl Into<bool>) -> Self

Whether to include the stat field in the response. Disable to speed-up the response. Defaults to true. NOTE: Commit verification is not implemented yet, so this setting does nothing.

pub fn verification(self, verification: impl Into<bool>) -> Self

Whether to include the verification field in the response. Disable to speed-up the response. Defaults to true. NOTE: Commit verification is not implemented yet, so this setting does nothing.

pub fn files(self, files: impl Into<bool>) -> Self

Whether to include the files field in the response. Disable to speed-up the response. Defaults to true. NOTE: Commit verification is not implemented yet, so this setting does nothing.

pub fn page(self, page: impl Into<i64>) -> Self

Optional page number of the results to fetch (1-based). Defaults to 1 if not set.

pub fn limit(self, limit: impl Into<i64>) -> Self

Optional number of commits to return per page (page-size). Defaults to the maximum your instance allows if not set.

pub fn not(self, not: impl Into<String>) -> Self

Commits that match the given specifier will not be listed.

impl GetCommitsBuilder

pub fn new(owner: impl ToString, repo: impl ToString) -> Self

pub async fn send(&self, client: &Client) -> Result<Vec<Commit>>

Send the request to get the commits.

Trait Implementations

impl Clone for GetCommitsBuilder

fn clone(&self) -> GetCommitsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetCommitsBuilder

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

Formats the value using the given formatter.

impl Serialize for GetCommitsBuilder

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.