rustdoc: Indicate struct can be created + fn

[mustakimali]

Visual hint to indicate the Struct that can be created from outside as well as highlight the functions that can be used as well (function that does not take self and returns the type, Option or Result)

Signed-off-by: Mohammad Mustakim Ali mustakimali@users.noreply.github.com

[rustbot]

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @jsha (or someone else) soon.

Please see the contribution instructions for more information.

[mustakimali]

Didn't mean to send the PR now, It's a draft PR :(

[rust-log-analyzer]

The job mingw-check failed! Check out the build log: (web) (plain)

Click to see the possible cause of the failure (guessed by this bot)

    Checking rustdoc v0.0.0 (/checkout/src/librustdoc)
error[E0308]: mismatched types
    --> src/librustdoc/clean/types.rs:1338:9
     |
1337 |     pub(crate) fn type_builder(&self) -> bool {
     |                                          ---- expected `bool` because of return type
1338 |         self.inputs.values.get(0).and_then(|v| v.to_self())
     |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ expected `bool`, found enum `Option`
     = note: expected type `bool`
     = note: expected type `bool`
                found enum `std::option::Option<clean::types::SelfTy>`
help: use `Option::is_some` to test if the `Option` has a value
     |
1338 |         self.inputs.values.get(0).and_then(|v| v.to_self()).is_some()

For more information about this error, try `rustc --explain E0308`.
error: could not compile `rustdoc` due to previous error
Build completed unsuccessfully in 0:01:51

[bors]

☔ The latest upstream changes (presumably #108228) made this pull request unmergeable. Please resolve the merge conflicts.

[Dylan-DPC]

@mustakimali any updates?

[mustakimali]

@mustakimali any updates?

@Dylan-DPC I wasn't sure if highlighting in the doc would be useful. So I quickly lost motivation and implemented something similar in the rust-analyzer instead.

rust-lang/rust-analyzer#16117

[05storm26]

This would be really useful in rustdoc. Having something for this in rust-analyzer is really not a substitute for this.

When you are reading the documentation of a type sometimes it is difficult to find out, how one should actually create an instance of that type from the documentation.

Having a separate Constructors section for each type, would be useful to navigate the documentation and understand how a type should be created (by calling what method/function) in unknown/unfamiliar crates.