elastio / bon

Next-gen compile-time-checked builder generator, named function's arguments, and more!
https://bon-rs.com
Apache License 2.0
1.16k stars 16 forks source link

Support generating builders from traits and trait impls #123

Open Veetaha opened 2 months ago

Veetaha commented 2 months ago

Read this if you found this issue because you want to have builder syntax for methods in traits

The design for this feature is rather hard and is yet to be researched, but bon should eventually be there! If you'd like to benefit from the builder syntax in your traits (e.g. assign default values, allow the caller to skip optional parameters, etc.), in the meantime I recommend you to just define a separate "parameters" struct annotated with a #[derive(bon::Builder)].

Example:

#[derive(bon::Builder)]
struct PutStarParams {
    #[builder(into)]
    github_repo: String,
    // .. other params
}

trait GithubClient {
    fn put_star(params: &PutStarParams) -> Result;
}

impl GithubClient for MyClient {
    fn put_star(params: &PutStarParams) -> Result { /**/ }
}

let client = MyClient::new();

// Use builder syntax to construct the params struct:
let params = PutStarParams::builder()
    .github_repo("elastio/bon")
    .build();

// call the trait method:
client.put_star(params)?;

A note for the community from the maintainers

Please vote on this issue by adding a 👍 reaction to help the maintainers with prioritizing it. You may add a comment describing your real use case related to this issue for us to better understand the problem domain. Sharing your use case will help with moving this issue forward!

Main issue body

We need some syntax to allow developers to generate builders from traits and trait impl blocks. This way it should be possible to define a trait that uses builder syntax for its methods.

The main problem here is that trait declarations and trait impl blocks are syntactically separated. We can also have multiple impl blocks. It would be awesome if all the impl blocks didn't have to redeclare the trait methods' parameter lists. The macro should probably generate a struct with input parameters that is then passed into the trait methods.

This all has a bunch of nuances (e.g. support for dyn Trait objects, methods without self). This feature requires a huge design effort.

dzmitry-lahoda commented 2 months ago

assuming it is possible to do, when it is useful?

Veetaha commented 2 months ago

As an example, the current Hashicorp Vault API uses functions with lots of positional parameters and it always accepts an impl Client.

If only we had a way to generate builder syntax for that Client trait, that would make it possible for vaultrs to use the syntax like this:

let client: impl Client = /**/

client
    .create_certificate()
    .mount("...")
    .cert_name("...")
    .aws_public_cert("...")
    .send()
    .await?;