Struct licensebat_rust::retriever::DocsRs

pub struct DocsRs { /* private fields */ }

docs.rs Retriever implementation.

It uses reqwest::Client to scrap the docs.rs website and retrieve the metadata of a dependency.

Note that when a crate is published it takes a while for the docs.rs website to compile it, so it can take a while to retrieve the metadata of recently uploaded crate.

You can provide yourself an instance of reqwest::Client by using the DocsRs::new constructor.

If you use DocsRs::default, it will instantiate a new reqwest::Client under the hood.

Implementations

impl DocsRs

pub const fn new(client: Client, store: Arc<Option<Store>>) -> Self

Creates a new Retriever. If you want to reuse a reqwest::Client pool consider using the DocsRs::new method.

Trait Implementations

impl Clone for DocsRs

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DocsRs

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

Formats the value using the given formatter.

impl Default for DocsRs

fn default() -> Self

Creates a new Retriever using the given reqwest::Client. If you don’t want to pass a reqwest::Client instance, consider using the DocsRs::default method.

impl Retriever for DocsRs

type Response = Pin<Box<dyn Future<Output = RetrievedDependency> + Send + 'static, Global>>

Future that resolves to a RetrievedDependency. It cannot fail.

fn get_dependency(&self, dependency: Dependency) -> Self::Response

Validates dependency’s information from the original source.