trustfall-rustdoc-adapter 56.3.0

Trustfall query adapter for rustdoc JSON data.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

//! Normalized signature rendering works from rustdoc's structured data, not
//! from Rust source text or already-rendered type strings. That keeps item IDs,
//! generic scopes, and path resolution available while formatting.
//!
//! The adapter layer decides which item component is being normalized and passes
//! the containing-item context here explicitly. Normalization is lazy:
//! we render the requested component after the query has traversed to a
//! normalized-signature vertex; we do not perform any kind of eager normalization.

mod context;
mod function_pointer;
mod names;
mod parameter_impl_trait;
mod paths;
mod sort_key;
mod types;

use crate::PackageIndex;

use super::vertex::{FunctionContext, TypeSignatureComponent};

/// Produce a normalized type signature for a function param or return type.
pub(super) fn fn_param_or_return_type_signature<'a>(
    crate_: &'a PackageIndex<'a>,
    function: FunctionContext<'a>,
    component: TypeSignatureComponent,
    type_: Option<&'a rustdoc_types::Type>,
) -> String {
    let mut context = context::FnNormalizationContext::new(crate_, function);
    match (component, type_) {
        (TypeSignatureComponent::FunctionParameter(position), Some(type_)) => {
            types::format_parameter_type(&mut context, position, type_)
        }
        (TypeSignatureComponent::ReturnValue, Some(type_)) => {
            types::format_type(&mut context, type_)
        }
        (_, None) => "()".to_string(), // empty fn return values hit this branch
    }
}