Skip to main content

Client

Struct Client 

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

HTTP client for the git-lfs API endpoints.

One instance per LFS endpoint URL. Client is cheap to clone and shares an underlying connection pool — clone freely.

§Authentication

Two complementary mechanisms:

  • Auth passed at construction is the initial auth — applied to every request, no retries on 401.
  • A credential helper attached via Self::with_credential_helper is queried on a 401 response: the request is retried once with the filled-in credentials, and the helper is told approve/reject based on the second attempt’s outcome. Once a fill succeeds, the client remembers the credentials and uses them for subsequent requests, so the 401 dance only happens at most once per process.

Implementations§

Source§

impl Client

Source

pub async fn batch(&self, req: &BatchRequest) -> Result<BatchResponse, ApiError>

POST /objects/batch to negotiate transfer URLs.

Source§

impl Client

Source

pub fn new(endpoint: Url, auth: Auth) -> Self

Build a client rooted at the given LFS endpoint.

endpoint is the LFS server URL (e.g. https://git-server.com/foo/bar.git/info/lfs). Subpaths (/objects/batch, /locks, …) are joined onto it per request.

Source

pub fn with_http_client(endpoint: Url, auth: Auth, http: Client) -> Self

Like new but reuses a caller-supplied reqwest::Client. Useful for sharing a connection pool, custom timeouts, proxies, etc.

Source

pub fn with_credential_helper(self, helper: Arc<dyn Helper>) -> Self

Attach a credential helper. On 401, the client will call helper.fill, retry once with the result, then approve/reject based on the outcome.

Source§

impl Client

Source

pub async fn create_lock( &self, req: &CreateLockRequest, ) -> Result<Lock, CreateLockError>

POST /locks to create a new lock.

Body decoding is flexible to accommodate both spec’d 409 → existing lock responses and the reference test server’s “200 with message but no lock” in-band-conflict pattern.

Source

pub async fn list_locks( &self, filter: &ListLocksFilter, ) -> Result<LockList, ApiError>

GET /locks with optional filters.

Source

pub async fn verify_locks( &self, req: &VerifyLocksRequest, ) -> Result<VerifyLocksResponse, ApiError>

POST /locks/verify to list locks partitioned into ours/theirs.

Per the spec, servers that don’t implement locking can return 404 here; that surfaces as ApiError::Status { status: 404, .. }. The caller (typically push) should treat that as “no locks to verify” rather than a hard failure — see is_not_found().

Source

pub async fn delete_lock( &self, id: &str, req: &DeleteLockRequest, ) -> Result<Lock, ApiError>

POST /locks/{id}/unlock to delete a lock.

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

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