Struct azure_devops_rust_api::git::commits::get_commits::RequestBuilder

pub struct RequestBuilder { /* private fields */ }

RequestBuilder provides a mechanism for setting optional parameters on a request.

Each RequestBuilder parameter method call returns Self, so setting of multiple parameters can be chained.

The building of a request is typically finalized by invoking .await on RequestBuilder. This implicitly invokes the IntoFuture::into_future() method, which converts RequestBuilder into a future that executes the request operation and returns a Result with the parsed response.

If you need lower-level access to the raw response details (e.g. to inspect response headers or raw body data) then you can finalize the request using the RequestBuilder::send() method which returns a future that resolves to a lower-level Response value.

Implementations

impl RequestBuilder

pub fn search_criteria_skip(self, search_criteria_skip: i32) -> Self

Number of entries to skip

pub fn search_criteria_top(self, search_criteria_top: i32) -> Self

Maximum number of entries to retrieve

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

Alias or display name of the author

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

Version string identifier (name of tag/branch, SHA1 of commit)

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

Version options - Specify additional modifiers to version (e.g Previous)

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

Version type (branch, tag, or commit). Determines how Id is interpreted

pub fn search_criteria_exclude_deletes( self, search_criteria_exclude_deletes: bool ) -> Self

Only applies when an itemPath is specified. This determines whether to exclude delete entries of the specified path.

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

If provided, a lower bound for filtering commits alphabetically

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

If provided, only include history entries created after this date (string)

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

What Git history mode should be used. This only applies to the search criteria when Ids = null and an itemPath is specified.

pub fn search_criteria_ids(self, search_criteria_ids: Vec<String>) -> Self

If provided, specifies the exact commit ids of the commits to fetch. May not be combined with other parameters.

pub fn search_criteria_include_links( self, search_criteria_include_links: bool ) -> Self

Whether to include the _links field on the shallow references

pub fn search_criteria_include_push_data( self, search_criteria_include_push_data: bool ) -> Self

Whether to include the push information

pub fn search_criteria_include_user_image_url( self, search_criteria_include_user_image_url: bool ) -> Self

Whether to include the image Url for committers and authors

pub fn search_criteria_include_work_items( self, search_criteria_include_work_items: bool ) -> Self

Whether to include linked work items

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

Path of item to search under

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

Version string identifier (name of tag/branch, SHA1 of commit)

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

Version options - Specify additional modifiers to version (e.g Previous)

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

Version type (branch, tag, or commit). Determines how Id is interpreted

pub fn search_criteria_show_oldest_commits_first( self, search_criteria_show_oldest_commits_first: bool ) -> Self

If enabled, this option will ignore the itemVersion and compareVersion parameters

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

If provided, an upper bound for filtering commits alphabetically

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

If provided, only include history entries created before this date (string)

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

Alias or display name of the committer

pub fn send(self) -> BoxFuture<'static, Result<Response>>

Returns a future that sends the request and returns a Response object that provides low-level access to full response details.

You should typically use .await (which implicitly calls IntoFuture::into_future()) to finalize and send requests rather than send(). However, this function can provide more flexibility when required.

Trait Implementations

impl Clone for RequestBuilder

fn clone(&self) -> RequestBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl IntoFuture for RequestBuilder

fn into_future(self) -> Self::IntoFuture

Returns a future that sends the request and returns the parsed response body.

You should not normally call this method directly, simply invoke .await which implicitly calls IntoFuture::into_future.

See IntoFuture documentation for more details.

type Output = Result<GitCommitRefList, Error>

The output that the future will produce on completion.

type IntoFuture = Pin<Box<dyn Future<Output = Result<GitCommitRefList, Error>> + Send + 'static, Global>>

Which kind of future are we turning this into?