Skip to main content

GitFoxClient

Struct GitFoxClient 

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

A GitFox API client bound to one host.

Implementations§

Source§

impl GitFoxClient

Source

pub fn builder(host: impl Into<String>) -> GitFoxClientBuilder

Source

pub fn base_url(&self) -> &Url

Source

pub fn has_token(&self) -> bool

Source

pub fn auth(&self) -> AuthApi<'_>

Source

pub fn repos(&self) -> ReposApi<'_>

Source

pub fn pull_requests(&self) -> PullRequestsApi<'_>

Source

pub fn principals(&self) -> PrincipalsApi<'_>

Source

pub fn pipelines(&self) -> PipelinesApi<'_>

Source

pub fn resolve(&self, path: &str) -> Result<Url>

Resolve an API path against the host.

Accepts /api/v1/user, api/v1/user and a fully qualified URL, so fx api can take whatever the user pasted.

Source

pub async fn request( &self, method: Method, path: &str, body: Option<&Value>, extra_headers: &[(String, String)], ) -> Result<RawResponse>

The one place an HTTP request is issued. Everything typed is built on top.

Transient failures are retried with exponential backoff — but only for methods that are safe to repeat. See is_retryable_method.

Source

pub async fn sse_lines<T: DeserializeOwned>( &self, path: &str, idle: Duration, ) -> Result<Vec<T>>

Read a server-sent-event stream, collecting each data: payload that deserialises into T.

Stops on the stream’s own event: error / data: eof, or once idle passes with no new bytes — a stream following something still in progress never ends on its own, so a snapshot has to decide when the backlog has been drained.

The client’s request timeout is deliberately not applied: it bounds a whole request/response, which for a stream would cut the body off mid-flight. The idle window bounds this instead.

Source

pub async fn get_json<T: DeserializeOwned>(&self, path: &str) -> Result<T>

Convenience wrapper for typed GET requests.

Trait Implementations§

Source§

impl Clone for GitFoxClient

Source§

fn clone(&self) -> GitFoxClient

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GitFoxClient

Redacted on purpose: the token must never reach a log line or an error message. Every {:?} of a client or anything holding one goes through here.

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: Sized + 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: Sized + 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 = !

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

fn try_from(value: U) -> Result<T, !>

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