Skip to main content

DocService

Struct DocService 

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

Document service

Provides centralized management of HTTP client (with auto-retry), cache, and document cache.

§Fields

  • client: HTTP client with retry middleware (shared reference for connection pool reuse)
  • cache: Generic cache instance
  • doc_cache: Document-specific cache

Implementations§

Source§

impl DocService

Source

pub fn new(cache: Arc<dyn Cache>) -> Result<Self>

Create new document service (with default TTL)

§Arguments
  • cache - cache instance
§Errors

Returns error if HTTP client creation fails

§Examples
use std::sync::Arc;
use crates_docs::tools::docs::DocService;
use crates_docs::cache::memory::MemoryCache;

let cache = Arc::new(MemoryCache::new(1000));
let service = DocService::new(cache).expect("Failed to create DocService");
§Note

This method uses the global HTTP client singleton for connection pool reuse. Make sure to call init_global_http_client() during server initialization for optimal performance.

Source

pub fn with_config( cache: Arc<dyn Cache>, cache_config: &CacheConfig, ) -> Result<Self>

Create new document service (with custom cache config)

§Arguments
  • cache - cache instance
  • cache_config - cache configuration
§Errors

Returns error if HTTP client creation fails

§Note

This method uses the global HTTP client singleton for connection pool reuse. If the global client is not initialized, it will be initialized with default config.

Source

pub fn with_full_config( cache: Arc<dyn Cache>, cache_config: &CacheConfig, _perf_config: &PerformanceConfig, ) -> Result<Self>

Create new document service (with full config)

§Arguments
  • cache - cache instance
  • cache_config - cache configuration
  • perf_config - performance configuration(used only for initializing global HTTP client if not yet initialized)
§Errors

Returns error if HTTP client creation fails

§Note

This method uses the global HTTP client singleton for connection pool reuse. The perf_config is used only if the global client hasn’t been initialized yet. For consistent configuration, call init_global_http_client() during server startup.

Source

pub fn client(&self) -> &ClientWithMiddleware

Get HTTP client (with retry middleware)

Source

pub fn cache(&self) -> &Arc<dyn Cache>

Get cache instance

Source

pub fn doc_cache(&self) -> &DocCache

Get document cache

Source

pub async fn fetch_html( &self, url: &str, tool_name: Option<&str>, ) -> Result<String, CallToolError>

Fetch HTML content from a URL

This is a shared utility method used by multiple tools to fetch HTML from docs.rs and crates.io.

§Arguments
  • url - The URL to fetch
  • tool_name - Optional tool name for better error messages (e.g., “lookup_crate”, “lookup_item”)
§Errors

Returns a CallToolError if:

  • The HTTP request fails
  • The response status is not successful
  • Reading the response body fails
Source

pub fn with_custom_client( cache: Arc<dyn Cache>, cache_config: &CacheConfig, client: Arc<ClientWithMiddleware>, ) -> Self

Create new document service with custom HTTP client (for testing)

Trait Implementations§

Source§

impl Default for DocService

Source§

fn default() -> Self

Returns the “default value” for a type. 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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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