portable-io 0.0.4

" A subset of Rust `std::io` functionality supported for `no-std`.
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

# portable-io

[![Crates.io Version](https://img.shields.io/crates/v/portable-io?style=flat-square)](https://crates.io/crates/portable-io)
[![Crates.io License](https://img.shields.io/crates/l/portable-io)](#license)

<!-- cargo-sync-readme start -->

Traits, helpers, and type definitions for core I/O functionality.
A subset from Rust `std::io` functionality supported for `no-std`.

**MSRV:**
- stable: `1.81.0`
- nightly: `nightly-2022-08-24`

NOTE: unstable configuration `--cfg portable_io_unstable_all` in Rust flags is required for Rust nightly
pre-`2024-06-09` to enable `error_in_core` feature directive (stabilized in June 2024).

## Features

- `alloc` (enabled by default) - mandatory feature - for alloc-related functionality
- `os-error` (unstable feature) - support raw OS errors - with some KNOWN PANICS due to MISSING FUNCTIONALITY
- `unix-iovec` (unstable feature) - use `iovec` from `libc` for data stored in IoSlice & IoSliceMut

## CFG options

- `portable_io_unstable_all` - enable all unstable option(s):
  - size hint optimization for Read iterator - uses Rust unstable `min_specialization` feature

To enable: use `--cfg portable_io_unstable_all` in Rust flags, set `RUSTFLAGS` env variable
when running `cargo build` or `cargo test` for example.

<!-- DOC TODO: INCLUDE & ADAPT MORE DOC COMMENTS FROM RUST STD IO LIBRARY CODE -->
<!-- DOC TODO: CLEANUP AS MANY CARGO DOC WARNINGS AS POSSIBLE & CHECK THIS IN CI -->

<!-- cargo-sync-readme end -->

## major TODO items

- Resolve doc warnings
- Include updates from newer versions of upstream Rust library code
- Include & adapt some more documentation from upstream Rust library code
- Resolve other TODO items in this code

## license

[MIT](./LICENSE-MIT) or [Apache 2.0](./LICENSE-APACHE) license options

NOTE that this code is adapted from Rust `std` library code version `1.59.0`
(last release version that did not require unstable `macro` feature to build `error` module)