Struct 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.

To finalize and submit the request, invoke .await, which converts the RequestBuilder into a future, executes the request 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 max_change_count(self, max_change_count: i32) -> Self

Number of changes to return (maximum 100 changes) Default: 0

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

Include policy details and check-in notes in the response. Default: false

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

Include workitems. Default: false

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

Include details about associated work items in the response. Default: null

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

Include renames. Default: false

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

Number of results to skip. Default: null

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

The maximum number of results to return. Default: null

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

Results are sorted by ID in descending order by default. Use id asc to sort by ID in ascending order.

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

Alias or display name of user who made the changes.

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

Whether or not to follow renames for the given item being queried.

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

If provided, only include changesets created after this date (string).

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

If provided, only include changesets after this changesetID.

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_item_path( self, search_criteria_item_path: impl Into<String>, ) -> Self

Path of item to search under.

pub fn search_criteria_mappings( self, search_criteria_mappings: Vec<TfvcMappingFilter>, ) -> Self

Following criteria available (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Default: null

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

If provided, only include changesets created before this date (string).

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

If provided, a version descriptor for the latest change list to include.

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 duplicate 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<TfvcChangeset, Error>

The output that the future will produce on completion.

type IntoFuture = Pin<Box<dyn Future<Output = Result<TfvcChangeset, Error>> + Send>>

Which kind of future are we turning this into?