https://github.com/not-fl3/nanoserde

Serialisation library with zero dependencies
https://github.com/not-fl3/nanoserde

Last synced: 21 days ago
JSON representation

Serialisation library with zero dependencies

• Host: GitHub
• URL: https://github.com/not-fl3/nanoserde
• Owner: not-fl3
• Created: 2020-06-20T18:21:22.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-12T17:15:30.000Z (6 months ago)
• Last Synced: 2024-05-13T01:31:08.909Z (6 months ago)
• Language: Rust
• Homepage:
• Size: 210 KB
• Stars: 583
• Watchers: 9
• Forks: 35
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

• zero - nanoserde
• awesome-list - nanoserde - fl3 | 275 | (Rust)

README

        
# nanoserde

[![Github Actions](https://github.com/not-fl3/nanoserde/workflows/Cross-compile/badge.svg)](https://github.com/not-fl3/nanoserde/actions?query=workflow%3A)

[![Crates.io version](https://img.shields.io/crates/v/nanoserde.svg)](https://crates.io/crates/nanoserde)

[![Documentation](https://docs.rs/nanoserde/badge.svg)](https://docs.rs/nanoserde)

[![Discord chat](https://img.shields.io/discord/710177966440579103.svg?label=discord%20chat)](https://discord.gg/WfEp6ut)

Fork of https://crates.io/crates/makepad-tinyserde with all the dependencies removed.

No more syn, proc_macro2 or quote in the build tree!

```

> cargo tree

nanoserde v0.1.0 (/../nanoserde)

└── nanoserde-derive v0.1.0 (/../nanoserde/derive)

```

## Example:

```rust

use nanoserde::{DeJson, SerJson};

#[derive(Clone, Debug, Default, DeJson, SerJson)]

pub struct Property {

    pub name: String,

    #[nserde(default)]

    pub value: String,

    #[nserde(rename = "type")]

    pub ty: String,

}

```

For more examples take a look at [tests](/tests)

## Features support matrix:

| Feature                                                   | json   | bin   | ron    | toml  |

| ---------------------------------------------------       | ------ | ----- | ------ | ----- |

| serialization                                             | yes    | yes   | yes    | no    |

| deserialization                                           | yes    | yes   | yes    | no    |

| container: Struct                                         | yes    | yes   | yes    | no    |

| container: Tuple Struct                                   | no     | yes   | yes    | no    |

| container: Enum                                           | yes    | yes   | yes    | no    |

| field: `std::collections::HashMap`                        | yes    | yes   | yes    | no    |

| field: `std::vec::Vec`                                    | yes    | yes   | yes    | no    |

| field: `Option`                                           | yes    | yes   | yes    | no    |

| field: `i*`/`f*`/`String`/`T: De*/Ser*`                   | yes    | yes   | yes    | no    |

| field attribute: `#[nserde(default)]`                     | yes    | no    | yes    | no    |

| field attribute: `#[nserde(rename = "")]`                 | yes    | yes   | yes    | no    |

| field attribute: `#[nserde(proxy = "")]`                  | no     | yes   | no     | no    |

| field attribute: `#[nserde(serialize_none_as_null)]`      | yes    | no    | no     | no    |

| container attribute: `#[nserde(default)]`                 | yes    | no    | yes    | no    |

| container attribute: `#[nserde(default = "")]`            | yes    | no    | yes    | no    |

| container attribute: `#[nserde(default_with = "")]`       | yes    | no    | yes    | no    |

| container attribute: `#[nserde(skip)]` (implies `default`)| yes    | no    | yes    | no    |

| container attribute: `#[nserde(serialize_none_as_null)]`  | yes    | no    | no     | no    |

| container attribute: `#[nserde(rename = "")]`             | yes    | yes   | yes    | no    |

| container attribute: `#[nserde(proxy = "")]`              | yes    | yes   | no     | no    |

| container attribute: `#[nserde(transparent)]`             | yes    | no    | no     | no    |

## Crate features:

All features are enabled by default. To enable only specific formats, import nanoserde using

```toml

nanoserde = { version = "*", default-features = false, features = ["std", "{format feature name}"] }

```

in your `Cargo.toml` and add one or more of the following crate features:

| Format    | Feature Name   |

| ----------| -------------- |

| Binary    | `binary`       |

| JSON      | `json`         |

| RON       | `ron`          |

| TOML      | `toml`         |