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 supports_iterations(self, supports_iterations: bool) -> Self

If true, subsequent pushes to the pull request will be individually reviewable. Set this to false for large pull requests for performance reasons if this functionality is not needed.

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<GitPullRequest, Error>

The output that the future will produce on completion.

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

Which kind of future are we turning this into?