rust/tests/rustdoc-json/fns/generics.rs

// ignore-tidy-linelength

//@ set wham_id = "$.index[*][?(@.name=='Wham')].id"
pub trait Wham {}

//@ is    "$.index[*][?(@.name=='one_generic_param_fn')].inner.function.generics.where_predicates" []
//@ count "$.index[*][?(@.name=='one_generic_param_fn')].inner.function.generics.params[*]" 1
//@ is    "$.index[*][?(@.name=='one_generic_param_fn')].inner.function.generics.params[0].name" '"T"'
//@ is    "$.index[*][?(@.name=='one_generic_param_fn')].inner.function.generics.params[0].kind.type.is_synthetic" false
//@ is    "$.index[*][?(@.name=='one_generic_param_fn')].inner.function.generics.params[0].kind.type.bounds[0].trait_bound.trait.id" $wham_id
//@ is    "$.index[*][?(@.name=='one_generic_param_fn')].inner.function.sig.inputs" '[["w", {"generic": "T"}]]'
pub fn one_generic_param_fn<T: Wham>(w: T) {}

//@ is    "$.index[*][?(@.name=='one_synthetic_generic_param_fn')].inner.function.generics.where_predicates" []
//@ count "$.index[*][?(@.name=='one_synthetic_generic_param_fn')].inner.function.generics.params[*]" 1
//@ is    "$.index[*][?(@.name=='one_synthetic_generic_param_fn')].inner.function.generics.params[0].name" '"impl Wham"'
//@ is    "$.index[*][?(@.name=='one_synthetic_generic_param_fn')].inner.function.generics.params[0].kind.type.is_synthetic" true
//@ is    "$.index[*][?(@.name=='one_synthetic_generic_param_fn')].inner.function.generics.params[0].kind.type.bounds[0].trait_bound.trait.id" $wham_id
//@ count "$.index[*][?(@.name=='one_synthetic_generic_param_fn')].inner.function.sig.inputs[*]" 1
//@ is    "$.index[*][?(@.name=='one_synthetic_generic_param_fn')].inner.function.sig.inputs[0][0]" '"w"'
//@ is    "$.index[*][?(@.name=='one_synthetic_generic_param_fn')].inner.function.sig.inputs[0][1].impl_trait[0].trait_bound.trait.id" $wham_id
pub fn one_synthetic_generic_param_fn(w: impl Wham) {}
rustdoc-json: Make the `fns/generics.rs` test much more robust 2022-02-25 13:34:00 -06:00			`// ignore-tidy-linelength`
rustdoc-json: Include GenericParamDefKind::Type::synthetic in JSON The rustdoc JSON for ``` pub fn f(_: impl Clone) {} ``` will effectively be ``` pub fn f<impl Clone: Clone>(_: impl Clone) ``` where a synthetic generic parameter called `impl Clone` with generic trait bound `Clone` is added to the function declaration. The generated HTML filters out these generic parameters by doing `self.params.iter().filter(\|p\| !p.is_synthetic_type_param())`, because the synthetic generic parameter is not of interest to regular users. For the same reason, we should expose whether or not a generic parameter is synthetic or not also in the rustdoc JSON, so that rustdoc JSON clients can also have the option to hide synthetic generic parameters. 2022-02-19 02:50:35 -06:00
Update all rustdoc-json/ tests to use the new style 2024-07-19 09:50:47 -05:00			`//@ set wham_id = "$.index[*][?(@.name=='Wham')].id"`
rustdoc-json: Make the `fns/generics.rs` test much more robust 2022-02-25 13:34:00 -06:00			`pub trait Wham {}`

Update all rustdoc-json/ tests to use the new style 2024-07-19 09:50:47 -05:00			`//@ is "$.index[*][?(@.name=='one_generic_param_fn')].inner.function.generics.where_predicates" []`
			`//@ count "$.index[][?(@.name=='one_generic_param_fn')].inner.function.generics.params[]" 1`
			`//@ is "$.index[*][?(@.name=='one_generic_param_fn')].inner.function.generics.params[0].name" '"T"'`
rustdoc: normalise type/field names in rustdoc-json-types/jsondoclint 2024-08-04 18:44:35 -05:00			`//@ is "$.index[*][?(@.name=='one_generic_param_fn')].inner.function.generics.params[0].kind.type.is_synthetic" false`
Update all rustdoc-json/ tests to use the new style 2024-07-19 09:50:47 -05:00			`//@ is "$.index[*][?(@.name=='one_generic_param_fn')].inner.function.generics.params[0].kind.type.bounds[0].trait_bound.trait.id" $wham_id`
rustdoc: normalise type/field names in rustdoc-json-types/jsondoclint 2024-08-04 18:44:35 -05:00			`//@ is "$.index[*][?(@.name=='one_generic_param_fn')].inner.function.sig.inputs" '[["w", {"generic": "T"}]]'`
rustdoc-json: Make the `fns/generics.rs` test much more robust 2022-02-25 13:34:00 -06:00			`pub fn one_generic_param_fn<T: Wham>(w: T) {}`

Update all rustdoc-json/ tests to use the new style 2024-07-19 09:50:47 -05:00			`//@ is "$.index[*][?(@.name=='one_synthetic_generic_param_fn')].inner.function.generics.where_predicates" []`
			`//@ count "$.index[][?(@.name=='one_synthetic_generic_param_fn')].inner.function.generics.params[]" 1`
			`//@ is "$.index[*][?(@.name=='one_synthetic_generic_param_fn')].inner.function.generics.params[0].name" '"impl Wham"'`
rustdoc: normalise type/field names in rustdoc-json-types/jsondoclint 2024-08-04 18:44:35 -05:00			`//@ is "$.index[*][?(@.name=='one_synthetic_generic_param_fn')].inner.function.generics.params[0].kind.type.is_synthetic" true`
Update all rustdoc-json/ tests to use the new style 2024-07-19 09:50:47 -05:00			`//@ is "$.index[*][?(@.name=='one_synthetic_generic_param_fn')].inner.function.generics.params[0].kind.type.bounds[0].trait_bound.trait.id" $wham_id`
rustdoc: normalise type/field names in rustdoc-json-types/jsondoclint 2024-08-04 18:44:35 -05:00			`//@ count "$.index[][?(@.name=='one_synthetic_generic_param_fn')].inner.function.sig.inputs[]" 1`
			`//@ is "$.index[*][?(@.name=='one_synthetic_generic_param_fn')].inner.function.sig.inputs[0][0]" '"w"'`
			`//@ is "$.index[*][?(@.name=='one_synthetic_generic_param_fn')].inner.function.sig.inputs[0][1].impl_trait[0].trait_bound.trait.id" $wham_id`
rustdoc-json: Make the `fns/generics.rs` test much more robust 2022-02-25 13:34:00 -06:00			`pub fn one_synthetic_generic_param_fn(w: impl Wham) {}`