Skip to main content

Client

Struct Client 

Source
pub struct Client { /* private fields */ }
Expand description

Client for Pathbase API

Version: 1.0.0

Implementations§

Source§

impl Client

Source

pub fn new(baseurl: &str) -> Self

Create a new client.

baseurl is the base URL provided to the internal reqwest::Client, and should include a scheme and hostname, as well as port and a path stem if applicable.

Source

pub fn new_with_client(baseurl: &str, client: Client) -> Self

Construct a new client with an existing reqwest::Client, allowing more control over its configuration.

baseurl is the base URL provided to the internal reqwest::Client, and should include a scheme and hostname, as well as port and a path stem if applicable.

Source§

impl Client

Source

pub async fn create_anon_path<'a>( &'a self, body: &'a AnonUploadBody, ) -> Result<ResponseValue<AnonUploadResponse>, Error<()>>

Sends a POST request to /api/v1/anon/paths

Source

pub async fn logout<'a>(&'a self) -> Result<ResponseValue<()>, Error<()>>

Sends a POST request to /api/v1/auth/logout

Source

pub async fn me<'a>(&'a self) -> Result<ResponseValue<User>, Error<()>>

Sends a GET request to /api/v1/auth/me

Source

pub async fn health<'a>( &'a self, ) -> Result<ResponseValue<HealthResponse>, Error<HealthResponse>>

Sends a GET request to /api/v1/health

Source

pub async fn create_repo<'a>( &'a self, body: &'a CreateRepoBody, ) -> Result<ResponseValue<Repo>, Error<()>>

Sends a POST request to /api/v1/repos

Source

pub async fn get_repo<'a>( &'a self, owner: &'a str, repo: &'a str, ) -> Result<ResponseValue<Repo>, Error<()>>

Sends a GET request to /api/v1/repos/{owner}/{repo}

Arguments:

  • owner: Owner username
  • repo: Repository name
Source

pub async fn delete_repo<'a>( &'a self, owner: &'a str, repo: &'a str, ) -> Result<ResponseValue<()>, Error<()>>

Sends a DELETE request to /api/v1/repos/{owner}/{repo}

Arguments:

  • owner: Owner username
  • repo: Repository name
Source

pub async fn update_repo<'a>( &'a self, owner: &'a str, repo: &'a str, body: &'a UpdateRepoBody, ) -> Result<ResponseValue<Repo>, Error<()>>

Sends a PATCH request to /api/v1/repos/{owner}/{repo}

Arguments:

  • owner: Owner username
  • repo: Repository name
  • body
Source

pub async fn list_graphs<'a>( &'a self, owner: &'a str, repo: &'a str, ) -> Result<ResponseValue<Vec<Graph>>, Error<()>>

Sends a GET request to /api/v1/repos/{owner}/{repo}/graphs

Arguments:

  • owner: Owner username
  • repo: Repository name
Source

pub async fn create_graph<'a>( &'a self, owner: &'a str, repo: &'a str, body: &'a UploadGraphBody, ) -> Result<ResponseValue<Graph>, Error<()>>

Sends a POST request to /api/v1/repos/{owner}/{repo}/graphs

Arguments:

  • owner: Owner username
  • repo: Repository name
  • body
Source

pub async fn get_graph<'a>( &'a self, owner: &'a str, repo: &'a str, slug: &'a str, ) -> Result<ResponseValue<Graph>, Error<()>>

Sends a GET request to /api/v1/repos/{owner}/{repo}/graphs/{slug}

Arguments:

  • owner: Owner username
  • repo: Repository name
  • slug: Graph slug
Source

pub async fn delete_graph<'a>( &'a self, owner: &'a str, repo: &'a str, slug: &'a str, ) -> Result<ResponseValue<()>, Error<()>>

Sends a DELETE request to /api/v1/repos/{owner}/{repo}/graphs/{slug}

Arguments:

  • owner: Owner username
  • repo: Repository name
  • slug: Graph slug
Source

pub async fn list_paths<'a>( &'a self, owner: &'a str, repo: &'a str, ) -> Result<ResponseValue<Vec<TracePath>>, Error<()>>

Sends a GET request to /api/v1/repos/{owner}/{repo}/paths

Arguments:

  • owner: Owner username
  • repo: Repository name
Source

pub async fn create_path<'a>( &'a self, owner: &'a str, repo: &'a str, body: &'a UploadPathBody, ) -> Result<ResponseValue<TracePath>, Error<()>>

Sends a POST request to /api/v1/repos/{owner}/{repo}/paths

Arguments:

  • owner: Owner username
  • repo: Repository name
  • body
Source

pub async fn get_path<'a>( &'a self, owner: &'a str, repo: &'a str, slug: &'a str, ) -> Result<ResponseValue<TracePath>, Error<()>>

Sends a GET request to /api/v1/repos/{owner}/{repo}/paths/{slug}

Arguments:

  • owner: Owner username
  • repo: Repository name
  • slug: Path slug
Source

pub async fn delete_path<'a>( &'a self, owner: &'a str, repo: &'a str, slug: &'a str, ) -> Result<ResponseValue<()>, Error<()>>

Sends a DELETE request to /api/v1/repos/{owner}/{repo}/paths/{slug}

Arguments:

  • owner: Owner username
  • repo: Repository name
  • slug: Path slug
Source

pub async fn update_path<'a>( &'a self, owner: &'a str, repo: &'a str, slug: &'a str, body: &'a UpdatePathBody, ) -> Result<ResponseValue<TracePath>, Error<()>>

Sends a PATCH request to /api/v1/repos/{owner}/{repo}/paths/{slug}

Arguments:

  • owner: Owner username
  • repo: Repository name
  • slug: Path slug
  • body
Source

pub async fn download_path<'a>( &'a self, owner: &'a str, repo: &'a str, slug: &'a str, ) -> Result<ResponseValue<Map<String, Value>>, Error<()>>

Sends a GET request to /api/v1/repos/{owner}/{repo}/paths/{slug}/download

Arguments:

  • owner: Owner username
  • repo: Repository name
  • slug: Path slug
Source

pub async fn get_profile<'a>(&'a self) -> Result<ResponseValue<User>, Error<()>>

Sends a GET request to /api/v1/settings/profile

Source

pub async fn update_profile<'a>( &'a self, body: &'a UpdateProfileBody, ) -> Result<ResponseValue<User>, Error<()>>

Sends a PATCH request to /api/v1/settings/profile

Source

pub async fn get_user<'a>( &'a self, username: &'a str, ) -> Result<ResponseValue<User>, Error<()>>

Sends a GET request to /api/v1/users/{username}

Arguments:

  • username: Username
Source

pub async fn list_repos<'a>( &'a self, username: &'a str, ) -> Result<ResponseValue<Vec<Repo>>, Error<()>>

Sends a GET request to /api/v1/users/{username}/repos

Arguments:

  • username: Username

Trait Implementations§

Source§

impl ClientHooks for &Client

Source§

async fn pre<E>( &self, request: &mut Request, info: &OperationInfo, ) -> Result<(), Error<E>>

Runs prior to the execution of the request. This may be used to modify the request before it is transmitted.
Source§

async fn post<E>( &self, result: &Result<Response, Error>, info: &OperationInfo, ) -> Result<(), Error<E>>

Runs after completion of the request.
Source§

async fn exec( &self, request: Request, info: &OperationInfo, ) -> Result<Response, Error>

Execute the request. Note that for almost any reasonable implementation this will include code equivalent to this: Read more
Source§

impl ClientInfo<()> for Client

Source§

fn api_version() -> &'static str

Get the version of this API. Read more
Source§

fn baseurl(&self) -> &str

Get the base URL to which requests are made.
Source§

fn client(&self) -> &Client

Get the internal reqwest::Client used to make requests.
Source§

fn inner(&self) -> &()

Get the inner value of type T if one is specified.
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

Auto Trait Implementations§

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