serde-url-params-rs's Introduction

Serde URL Params

Serialization of URL parameters from Rust structs.

Example

#[derive(Debug, Serialize)]
enum Filter { New, Registered, Blocked }

#[derive(Debug, Serialize)]
struct Params {
    cursor: Option<usize>,
    per_page: Option<usize>,
    username: String,
    filter: Vec<Filter>,
}

let params = Params {
    cursor: Some(42),
    per_page: None,
    username: String::from("boxdot"),
    filter: vec![Filter::New, Filter::Blocked],
};
assert_eq!(
    serde_url_params::to_string(&params).unwrap(),
    "cursor=42&username=boxdot&filter=New&filter=Blocked"
);

License

Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT License (LICENSE-MIT or http://opensource.org/licenses/MIT)

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this document by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

serde-url-params-rs's People

Contributors

Stargazers

Watchers

serde-url-params-rs's Issues

`Option<SomeStruct>` yields MapError - with and without flatten annotations

Sometimes there are optional parameters which I tried to model as fields in a struct using Option<_>

// this struct just exists for structuring the data
#[derive(Serialize,Debug)]
pub struct ImaginaryNum {
     real: u64,
     imaginary: uu64,
}

#[derive(Serialize,Debug)]
pub struct MyParams {
     whatever: bool,
    x: u64,
    #[serde(flatten)]
    y : Option<ImaginaryNum>, // <<< error
    // #[serde(flatten)]
    // z: Vec<ImagninaryNum> would also be nice if that worked, just serializing all it's members
}

How can I make this work?

Add code coverage generation in CI

Option to serialize Vec<T> into comma-separated list

This would be nice for APIs that require a comma-separated list for authorization scopes.

I was looking into the source code myself, but I only have limited knowledge of the inner workings of serde. Not sure where a Vec is being iterated in the custom Serializer of this crate.