ArchClient

Struct ArchClient 

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

What: Main client for arch-toolkit operations.

Inputs: None (created via new() or builder())

Output: ArchClient instance ready for use

Details:

  • Wraps reqwest::Client with arch-toolkit-specific configuration
  • Provides access to AUR operations via aur() method
  • Handles rate limiting automatically
  • Configurable via ArchClientBuilder

Implementations§

Source§

impl ArchClient

Source

pub fn new() -> Result<Self>

What: Create a new ArchClient with default configuration.

Inputs: None

Output:

  • Result<ArchClient> with default settings, or error if client creation fails

Details:

  • Default timeout: 30 seconds
  • Default user agent: arch-toolkit/{version}
  • Uses existing rate limiting (500ms base delay)
§Errors
  • Returns Err(ArchToolkitError::Network) if reqwest::Client creation fails
Source

pub const fn builder() -> ArchClientBuilder

What: Create a builder for custom ArchClient configuration.

Inputs: None

Output:

  • ArchClientBuilder with default values that can be customized

Details:

  • Starts with sensible defaults
  • Use builder methods to customize timeout, user agent, etc.
  • Call build() to create the ArchClient
Source

pub const fn aur(&self) -> Aur<'_>

What: Get access to AUR operations.

Inputs: None

Output:

  • Aur wrapper that provides AUR-specific methods

Details:

  • Returns a reference wrapper that provides search(), info(), comments(), pkgbuild() methods
  • The Aur wrapper uses this client’s HTTP client and configuration
Source

pub const fn invalidate_cache(&self) -> CacheInvalidator<'_>

What: Invalidate cache entries.

Inputs: None

Output:

  • CacheInvalidator builder for cache invalidation operations

Details:

  • Returns a builder that allows invalidating specific cache entries
  • Returns a no-op builder if caching is not enabled
Source

pub async fn health_check(&self) -> Result<bool>

What: Quick connectivity check for archlinux.org services.

Inputs: None

Output:

  • Result<bool> - true if services are operational, false or error otherwise

Details:

  • Performs lightweight HTTP request to AUR RPC API
  • Uses shorter timeout than regular operations (5s default)
  • Does not count against rate limiting quota
  • Useful for pre-flight connectivity checks
§Errors
  • Returns Err(ArchToolkitError::Network) if the HTTP request fails
Source

pub async fn health_status(&self) -> Result<HealthStatus>

What: Detailed health status for archlinux.org services.

Inputs: None

Output:

  • Result<HealthStatus> with detailed service status and latency

Details:

  • Performs lightweight HTTP request to AUR RPC API
  • Measures latency and determines service status
  • Uses shorter timeout than regular operations
  • Returns HealthStatus::Degraded if latency > 2 seconds
§Errors
  • Returns Err(ArchToolkitError::Network) if the HTTP request fails

Trait Implementations§

Source§

impl Debug for ArchClient

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> 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, 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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