Struct RustdocQueryService 

pub struct RustdocQueryService { /* private fields */ }

Public application boundary for rustdoc-query operations and serialization.

Implementations

impl RustdocQueryService

pub fn new() -> Result<Self, ApiError>

Opens the platform’s rustdoc cache.

Set RUSTDOC_QUERY_CACHE_DIR to place the cache in an explicit directory.

Errors

Returns an API error when the cache directory cannot be initialized.

pub async fn overview(&self, request: OverviewRequest) -> OverviewOutcome

Orientation view for a crate root or one of its public modules.

pub async fn find(&self, request: FindRequest) -> FindOutcome

Search a crate’s public surface by name, kind, module, or documentation.

pub async fn get_item(&self, request: GetItemRequest) -> GetItemOutcome

Full public detail for one item or inherent method.

pub fn output_format(requested: Option<OutputFormat>) -> OutputFormat

Resolves output_format, falling back to the schema default when omitted.

pub fn json_value<T: Serialize>(value: &T) -> Result<Value, ApiError>

Serializes value as a JSON value.

Errors

Returns an API error when JSON serialization fails.

pub fn toon<T: Serialize>(value: &T) -> Result<String, ApiError>

Serializes value in TOON format.

Errors

Returns an API error when TOON serialization fails.

Trait Implementations

impl Debug for RustdocQueryService

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

Formats the value using the given formatter.