serde_str_helpers 0.1.2

Helpers for using serde with strings
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

# Serde string helpers
[![crates.io](https://meritbadge.herokuapp.com/serde_str_helpers)](https://crates.io/crates/serde_str_helpers)
![Build](https://github.com/LNP-BP/rust-amplify/workflows/Build/badge.svg)
![Tests](https://github.com/LNP-BP/rust-amplify/workflows/Tests/badge.svg)
![Lints](https://github.com/LNP-BP/rust-amplify/workflows/Lints/badge.svg)
[![codecov](https://codecov.io/gh/LNP-BP/rust-amplify/branch/master/graph/badge.svg)](https://codecov.io/gh/LNP-BP/rust-amplify)
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)

Rust crate containing helpers for using serde with strings.

## About

Currently there is only a helper for deserializing stringly values more
efficiently by avoiding allocation (and copying) in certain cases. New helpers
may appear in the future.

This crate is `no_std` but **does** require `alloc`.

## `DeserBorrowStr`

A helper for deserializing using `TryFrom` more efficiently.

When using `#[serde(try_from = "String"]` when deserializing a value that
doesn't need to hold the string (e.g. an integer value) `serde` would
allocate the string even if it doesn't have to. (Such as in the case of
non-escaped Json string.)
                                                                            
A naive idea is to use `std::borrow::Cow` to solve it. Sadly, the
implementation of Deserialize for Cow<'de, str> doesn't borrow the string,
so it still allocates needlessly. This helper solves the issue.
                                                                            
Our DeserBorrowStr is written such that it borrows the `str` when possible,
avoiding the allocation. It may still need to allocate, for example if
string decoding (unescaping) has to be performed.

## MSRV

The official MSRV is 1.41.1 for now and may be lowered later.

## License

MIT