Expand description
Document lookup tool module
Provides tools and services for querying Rust crate documentation.
§Submodules
cache: Document cachehtml: HTML processinglookup_crate: Crate documentation lookuplookup_item: Item documentation lookupsearch: 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