Struct Client

Source
pub struct Client {
    pub base_path: String,
    pub http_client: Client,
    pub api_token: String,
}
Expand description

Configuration for the Bitbucket Server API HTTP client.

This struct holds all the necessary configuration for making API requests to a Bitbucket Server instance.

Fields§

§base_path: String

Base URL for the bitbucket server. It must end with /rest.

§http_client: Client

The HTTP client to use for making requests.

§api_token: String

The API token to use for authentication.

Implementations§

Source§

impl Client

The Bitbucket API client implementation.

Source

pub fn api(self) -> Api

Access Bitbucket’s api API endpoints.

This method returns an Api struct that provides access to all the API endpoints under the /rest/api path.

§Returns

An Api struct that can be used to access API endpoints.

Source§

impl Client

HTTP request and response handling implementations for the Bitbucket API client.

Source

pub async fn builder(&self, req: RequestBuilder) -> RequestBuilder

Create a request builder with authentication headers.

This method adds the necessary authentication and content type headers to a request.

§Arguments
  • req - The request builder to add headers to.
§Returns

A request builder with the headers added.

Source

pub fn with_http_client(&mut self, http_client: Client)

Set a custom HTTP client with specific configuration.

This method allows you to use a custom HTTP client with specific configuration options, such as timeouts, proxies, etc.

§Arguments
  • http_client - The custom HTTP client to use.
§Example
use bitbucket_server_rs::client::new;
use reqwest::ClientBuilder;
use std::time::Duration;

let mut client = new("https://bitbucket-server/rest", "API_TOKEN");

// Create a custom HTTP client with a 30-second timeout
let http_client = ClientBuilder::new()
    .timeout(Duration::from_secs(30))
    .build()
    .expect("Failed to build HTTP client");

// Set the custom HTTP client
client.with_http_client(http_client);
Source

pub async fn get<T: ApiRequest>( &self, uri: &str, params: Option<HashMap<String, String>>, ) -> ApiResponse<T::Output>

Send a GET request to the Bitbucket Server API.

This method sends a GET request to the specified URI with the given query parameters.

§Arguments
  • uri - The URI to send the request to, relative to the base path.
  • params - Optional query parameters to include in the request.
§Returns

A Result containing either the response data or an error.

Source

pub async fn post<T: ApiRequest>( &self, uri: &str, body: &str, ) -> ApiResponse<<T as ApiRequest>::Output>

Send a POST request to the Bitbucket Server API.

This method sends a POST request to the specified URI with the given body.

§Arguments
  • uri - The URI to send the request to, relative to the base path.
  • body - The body to include in the request.
§Returns

A Result containing either the response data or an error.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Client

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Client

Source§

fn default() -> Client

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,