Aur

Struct Aur 

Source
pub struct Aur<'a> { /* private fields */ }
Expand description

What: Wrapper for AUR operations using an ArchClient.

Inputs: None (created via ArchClient::aur())

Output: Aur instance that provides AUR operation methods

Details:

  • Holds a reference to ArchClient to access HTTP client and configuration
  • Provides methods: search(), info(), comments(), pkgbuild()
  • All operations use the client’s configured timeout and user agent
  • Rate limiting is handled automatically

Implementations§

Source§

impl<'a> Aur<'a>

Source

pub async fn search(&self, query: &str) -> Result<Vec<AurPackage>>

What: Search for packages in the AUR by name.

Inputs:

  • query: Search query string.

Output:

  • Result<Vec<AurPackage>> containing search results, or an error.

Details:

  • Uses AUR RPC v5 search endpoint.
  • Limits results to 200 packages (AUR default).
  • Percent-encodes the query string for URL safety.
  • Applies rate limiting for archlinux.org requests.
  • Returns empty vector if no results found (not an error).
§Errors
  • Returns Err(ArchToolkitError::Network) if the HTTP request fails
  • Returns Err(ArchToolkitError::InvalidInput) if the URL is not from archlinux.org
Source

pub async fn info(&self, names: &[&str]) -> Result<Vec<AurPackageDetails>>

What: Fetch detailed information for one or more AUR packages.

Inputs:

  • names: Slice of package names to fetch info for.

Output:

  • Result<Vec<AurPackageDetails>> containing package details, or an error.

Details:

  • Uses AUR RPC v5 info endpoint.
  • Fetches info for all packages in a single request (more efficient).
  • Returns empty vector if no packages found (not an error).
  • Applies rate limiting for archlinux.org requests.
§Errors
  • Returns Err(ArchToolkitError::Network) if the HTTP request fails
  • Returns Err(ArchToolkitError::InvalidInput) if the URL is not from archlinux.org
Source

pub async fn comments(&self, pkgname: &str) -> Result<Vec<AurComment>>

What: Fetch AUR package comments by scraping the AUR package page.

Inputs:

  • pkgname: Package name to fetch comments for.

Output:

  • Result<Vec<AurComment>> with parsed comments sorted by date (latest first); Err on failure.

Details:

  • Fetches HTML from https://aur.archlinux.org/packages/<pkgname>
  • Uses scraper to parse HTML and extract comment elements
  • Parses dates to Unix timestamps for sorting
  • Sorts comments by date descending (latest first)
  • Handles pinned comments (appear before “Latest Comments” heading)
§Errors
  • Returns Err(ArchToolkitError::Network) if the HTTP request fails
  • Returns Err(ArchToolkitError::InvalidInput) if the URL is not from archlinux.org
  • Returns Err(ArchToolkitError::Parse) if HTML parsing fails
Source

pub async fn pkgbuild(&self, package: &str) -> Result<String>

What: Fetch PKGBUILD content for an AUR package.

Inputs:

  • package: Package name to fetch PKGBUILD for.

Output:

  • Result<String> with PKGBUILD text when available; Err on network or lookup failure.

Details:

  • Fetches from https://aur.archlinux.org/cgit/aur.git/plain/PKGBUILD?h={package}
  • Applies rate limiting (200ms minimum interval between requests)
  • Uses timeout from client configuration
  • Returns raw PKGBUILD text
§Errors
  • Returns Err(ArchToolkitError::Network) if the HTTP request fails
  • Returns Err(ArchToolkitError::InvalidInput) if the URL is not from archlinux.org
  • Returns Err(ArchToolkitError::Parse) if rate limiter mutex is poisoned

Trait Implementations§

Source§

impl AurApi for Aur<'_>

Source§

fn search<'life0, 'life1, 'async_trait>( &'life0 self, query: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<AurPackage>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

What: Search for packages in the AUR by name.

Inputs:

  • query: Search query string

Output:

  • Result<Vec<AurPackage>> containing search results, or an error

Details:

  • Delegates to the underlying search module function
Source§

fn info<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, names: &'life1 [&'life2 str], ) -> Pin<Box<dyn Future<Output = Result<Vec<AurPackageDetails>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

What: Fetch detailed information for one or more AUR packages.

Inputs:

  • names: Slice of package names to fetch info for

Output:

  • Result<Vec<AurPackageDetails>> containing package details, or an error

Details:

  • Delegates to the underlying info module function
Source§

fn comments<'life0, 'life1, 'async_trait>( &'life0 self, pkgname: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<AurComment>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

What: Fetch AUR package comments.

Inputs:

  • pkgname: Package name to fetch comments for

Output:

  • Result<Vec<AurComment>> with parsed comments, or an error

Details:

  • Delegates to the underlying comments module function
Source§

fn pkgbuild<'life0, 'life1, 'async_trait>( &'life0 self, package: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

What: Fetch PKGBUILD content for an AUR package.

Inputs:

  • package: Package name to fetch PKGBUILD for

Output:

  • Result<String> with PKGBUILD text, or an error

Details:

  • Delegates to the underlying pkgbuild module function
Source§

impl<'a> Debug for Aur<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Aur<'a>

§

impl<'a> !RefUnwindSafe for Aur<'a>

§

impl<'a> Send for Aur<'a>

§

impl<'a> Sync for Aur<'a>

§

impl<'a> Unpin for Aur<'a>

§

impl<'a> !UnwindSafe for Aur<'a>

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