tinyvec_string 0.1.1

tinyvec based string types
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
43
44
45
46
47
48
49
50
51
52
53
54
55

[![crates.io](https://img.shields.io/crates/v/tinyvec_string.svg)](https://crates.io/crates/tinyvec_string)
[![docs.rs](https://docs.rs/tinyvec_string/badge.svg)](https://docs.rs/tinyvec_string/)

# tinyvec_string


[`tinyvec`](https://github.com/Lokathor/tinyvec) based string types.

See [the docs.rs documentation](https://docs.rs/tinyvec_string/)

`tinyvec_string` provides two string types:
* `ArrayString`, a string backed by a fixed-size array on the stack,
  using `ArrayVec`
* `TinyString`, a string backed by either a fixed-size array on the stack
  or a `Vec` on the heap, using `TinyVec`

## Features


Like `tinyvec`, `tinyvec_string` is `no_std` by default.

`ArrayString` has no dependencies (other than `tinyvec` and `core`).

`TinyString` requires the the `alloc` cargo feature to be enabled because
it has a dependency on `alloc`:

```toml
[dependencies]
tinyvec_string = { version = "0.1.0", features = ["alloc"] }
```

Error types implement `std::error::Error` when the `std` feature is
enabled.

## Safety


This crate strives to be as safe as possible. Almost all internal `unsafe`
code is copied verbatim from `std`'s `String` implementation for maximum
reliability and performance. That said, this `unsafe` code is relying on
`tinyvec`, which is 100% safe. The implication of this is that if you
implement `Array`, a safe trait to implement, on your own type
incorrectly (not always returning the same slice), then you could have
memory safety problems. Using this crate with the primitive array types
(`[u8; N]`) will cause no problems.

## Contributing


Feel free to open an issue if you have a problem, or open a pull request if you
have a solution. Also feel free to reach me on [Discord](https://discord.com)
on [the Rust Community Server](https://discord.gg/aVESxV8) @ThatsNoMoon#1075.

## License


`tinyvec_string` is dual-licensed under Apache-2.0 and MIT. Large sections of
code, documentation, and tests were copied verbatim or copied and modified from
[rust-lang/rust](https://github.com/rust-lang/rust); copyright for such content
belongs to the original author.