Skip to main content

Module docs

Module docs 

Source
Expand description

Document lookup tool module

Provides tools and services for querying Rust crate documentation.

§Submodules

  • cache: Document cache
  • html: HTML processing
  • lookup_crate: Crate documentation lookup
  • lookup_item: Item documentation lookup
  • search: Crate search

§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");

Re-exports§

pub use lookup_crate::LookupCrateTool;
pub use lookup_item::LookupItemTool;
pub use search::SearchCratesTool;
pub use cache::DocCacheTtl;

Modules§

cache
Document cache module
html
HTML processing utilities
lookup_crate
Lookup crate documentation tool
lookup_item
Lookup item documentation tool
search
Search crates tool

Structs§

DocService
Document service

Enums§

Format
Output format for documentation

Functions§

build_crates_io_search_url
Build crates.io API search URL
build_docs_item_url
Build docs.rs search URL for item lookup
build_docs_url
Build docs.rs URL for crate documentation
crates_io_base_url
Get the crates.io base URL
docs_rs_base_url
Get the docs.rs base URL
parse_format
Parse format string into Format enum