VienDesu/schemars
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update docs

Browse source
This commit is contained in:
Graham Esau 2021-03-25 22:51:51 +00:00
parent cb26e783dc
commit 93435d519a
5 changed files with 23 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

5
docs/examples/8-enum_repr.md
View file

@ -1,13 +1,14 @@
---
layout: default
title: Serialize enum as number (serde_repr)
title: Serialize Enum as Number (serde_repr)
parent: Examples
nav_order: 8
summary: >-
Generating a schema for with a C-like enum compatible with serde_repr.
nav_exclude: true # schemars 0.8.2 currently unreleased
---
# Deriving JsonSchema with Fields Using Custom Serialization
# Serialize Enum as Number (serde_repr Compatibility)
If you use the `#[repr(...)]` attribute on an enum to give it a C-like representation, then you may also want to use the [serde_repr](https://github.com/dtolnay/serde-repr) crate to serialize the enum values as numbers. In this case, you should use the corresponding `JsonSchema_repr` derive to ensure the schema for your type reflects how serde formats your type.