Skip to content

Commit 4072d2a

Browse files
committed
Rename to core2
1 parent 2bf87b3 commit 4072d2a

3 files changed

Lines changed: 16 additions & 12 deletions

File tree

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "core2"
3-
version = "0.1.0"
3+
version = "0.3.0-alpha.1"
44
authors = ["Brendan Molloy <brendan@bbqsrc.net>"]
55
description = "The bare essentials of std::io for use in no_std. Alloc support is optional."
66
license = "Apache-2.0 OR MIT"

LICENSE-MIT

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2020 Brendan Molloy <brendan@bbqsrc.net>
1+
Copyright (c) 2020-2021 Brendan Molloy <brendan@bbqsrc.net>
22

33
Permission is hereby granted, free of charge, to any person obtaining a copy
44
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,37 @@
1-
# bare-io
1+
# core2
22

3-
[![Actions Status](https://github.com/bbqsrc/bare-io/workflows/CI/badge.svg)](https://github.com/bbqsrc/bare-io/actions)
4-
[![Documentation](https://docs.rs/bare-io/badge.svg)](https://docs.rs/bare-io)
3+
**NOTE: This repository was recently renamed from bare-io. `bare_io` is now `core2::io`.**
4+
5+
[![Actions Status](https://github.com/bbqsrc/core2/workflows/CI/badge.svg)](https://github.com/bbqsrc/core2/actions)
6+
[![Documentation](https://docs.rs/core2/badge.svg)](https://docs.rs/core2)
57
![Minimum Supported Rust Version (MSRV)](https://img.shields.io/badge/rust-v1.47.0+-blue)
68

7-
Ever wanted a `Cursor` in `no_std`? Well now you can have it. A 'fork' of Rust's `std::io` module for `no_std` environments,
8-
with the added benefit of not needing `alloc`.
9+
Ever wanted a `Cursor` or the `Error` trait in `no_std`? Well now you can have it. A 'fork' of Rust's `std` modules for `no_std` environments, with the added benefit of optionally taking advantage of `alloc`.
910

10-
The goal of this crate is to provide a stable interface for building I/O trait functionality in
11+
The goal of this crate is to provide a stable interface for building I/O and error trait functionality in
1112
`no_std` environments. The current code corresponds to the most recent stable API of Rust 1.47.0.
1213
It is also a goal to achieve a true alloc-less experience, with opt-in alloc support.
1314

1415
This crate works on `stable` with some limitations in functionality, and `nightly` without limitations by adding
1516
the relevant feature flag.
1617

17-
This crate is `no_std` by default — you must opt into enabling `std` if required.
18+
This crate is `std` by default -- use no default features to get `no_std` mode.
1819

1920
## Usage
2021

2122
```toml
2223
[dependencies]
23-
bare-io = "0.2"
24+
core2 = "0.3"
2425
```
2526

26-
Add the crate, use the things you would usually want from `std::io`, but instead from `bare_io`.
27+
Add the crate, use the things you would usually want from `std::io`, but instead from `core2::io`, and
28+
use `core2::error::Error` in place of `std::error::Error`.
2729

2830
### Features
2931

3032
- **std**: enables `std` pass-throughs for the polyfilled types, but allows accessing the new types
3133
- **alloc**: enable aspects of the `Read` and `Write` traits that require `alloc` support (WIP)
3234
- **nightly**: enables **nightly**-only features, such as `BufReader` and `BufWriter` with const generic buffers.
33-
- **nightly-std**: enables `std` with **nightly**-only features
3435

3536
### Differences to `std::io`
3637

@@ -49,11 +50,14 @@ Other than items perhaps being entirely missing or certain functions unavailable
4950

5051
All of the below are works in progress, but should help with demonstrating how to use this crate.
5152

53+
- [thiserror_core2](https://github.com/bbqsrc/thiserror-core2): fork of `thiserror` using the `core2::error::Error` trait.
54+
<!--
5255
- [fastvlq](https://github.com/bbqsrc/fastvlq): variable-length `u64` type with no-std reader support with `bare-io`
5356
- [byteorder_bare-io](https://github.com/bbqsrc/byteorder): personal fork of `byteorder` crate
5457
- [zstd-rs](https://github.com/bbqsrc/zstd-rs): personal fork of `zstd` crate to demonstrate `bare-io` in a more complex setting
5558
- [comde](https://github.com/bbqsrc/comde): do compression/decompression similarly to how one might use `serde`
5659
- [pathtrie](https://github.com/bbqsrc/pathtrie): a prefix trie optimised for paths and URLs, using an FST for fast lookups in no_std.
60+
-->
5761

5862
## License
5963

0 commit comments

Comments
 (0)