Move the core::io implementation to separate module

This commit is contained in:
Igor Matuszewski 2020-01-21 19:25:22 +01:00 committed by Igor Matuszewski
parent 3b03040cf0
commit 8e8058a491
2 changed files with 23 additions and 41 deletions

View File

@ -1,21 +1,9 @@
//! A tiny, `no_std`-friendly facade around `std::io`. //! Reimplements core logic and types from `std::io` in an `alloc`-friendly
//! Reexports types from `std` when available; otherwise reimplements and //! fashion.
//! provides some of the core logic. #![cfg(not(feature = "std"))]
//!
//! The main reason that `std::io` hasn't found itself reexported as part of
//! the `core` crate is the `std::io::{Read, Write}` traits' reliance on
//! `std::io::Error`, which may contain internally a heap-allocated `Box<Error>`
//! and/or now relying on OS-specific `std::backtrace::Backtrace`.
//!
//! Because of this, we simply redefine those traits as if the error type is
//! simply a `&'static str` and reimplement those traits for `core` primitives
//! or `alloc` types, e.g. `Vec<T>`.
#[cfg(not(feature = "std"))]
use lib::*; use lib::*;
#[cfg(feature = "std")]
pub use std::io::ErrorKind;
#[cfg(not(feature = "std"))]
pub enum ErrorKind { pub enum ErrorKind {
InvalidData, InvalidData,
WriteZero, WriteZero,
@ -23,7 +11,6 @@ pub enum ErrorKind {
UnexpectedEof, UnexpectedEof,
} }
#[cfg(not(feature = "std"))]
impl ErrorKind { impl ErrorKind {
#[inline] #[inline]
fn as_str(&self) -> &'static str { fn as_str(&self) -> &'static str {
@ -36,20 +23,15 @@ impl ErrorKind {
} }
} }
#[cfg(feature = "std")]
pub use std::io::Error;
#[cfg(not(feature = "std"))]
pub struct Error { pub struct Error {
repr: Repr, repr: Repr,
} }
#[cfg(not(feature = "std"))]
enum Repr { enum Repr {
Simple(ErrorKind), Simple(ErrorKind),
Custom(ErrorKind, Box<dyn serde::de::StdError + Send + Sync>), Custom(ErrorKind, Box<dyn serde::de::StdError + Send + Sync>),
} }
#[cfg(not(feature = "std"))]
impl Display for Error { impl Display for Error {
fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result { fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
match &self.repr { match &self.repr {
@ -59,17 +41,14 @@ impl Display for Error {
} }
} }
#[cfg(not(feature = "std"))]
impl Debug for Error { impl Debug for Error {
fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result { fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
Display::fmt(self, fmt) Display::fmt(self, fmt)
} }
} }
#[cfg(not(feature = "std"))]
impl serde::de::StdError for Error {} impl serde::de::StdError for Error {}
#[cfg(not(feature = "std"))]
impl From<ErrorKind> for Error { impl From<ErrorKind> for Error {
#[inline] #[inline]
fn from(kind: ErrorKind) -> Error { fn from(kind: ErrorKind) -> Error {
@ -79,7 +58,6 @@ impl From<ErrorKind> for Error {
} }
} }
#[cfg(not(feature = "std"))]
impl Error { impl Error {
#[inline] #[inline]
pub fn new<E>(kind: ErrorKind, error: E) -> Error pub fn new<E>(kind: ErrorKind, error: E) -> Error
@ -92,14 +70,8 @@ impl Error {
} }
} }
#[cfg(feature = "std")]
pub use std::io::Result;
#[cfg(not(feature = "std"))]
pub type Result<T> = result::Result<T, Error>; pub type Result<T> = result::Result<T, Error>;
#[cfg(feature = "std")]
pub use std::io::Write;
#[cfg(not(feature = "std"))]
pub trait Write { pub trait Write {
fn write(&mut self, buf: &[u8]) -> Result<usize>; fn write(&mut self, buf: &[u8]) -> Result<usize>;
@ -122,7 +94,6 @@ pub trait Write {
fn flush(&mut self) -> Result<()>; fn flush(&mut self) -> Result<()>;
} }
#[cfg(not(feature = "std"))]
impl<W: Write> Write for &mut W { impl<W: Write> Write for &mut W {
#[inline] #[inline]
fn write(&mut self, buf: &[u8]) -> Result<usize> { fn write(&mut self, buf: &[u8]) -> Result<usize> {
@ -140,7 +111,6 @@ impl<W: Write> Write for &mut W {
} }
} }
#[cfg(not(feature = "std"))]
impl Write for Vec<u8> { impl Write for Vec<u8> {
#[inline] #[inline]
fn write(&mut self, buf: &[u8]) -> Result<usize> { fn write(&mut self, buf: &[u8]) -> Result<usize> {
@ -160,9 +130,6 @@ impl Write for Vec<u8> {
} }
} }
#[cfg(feature = "std")]
pub use std::io::Read;
#[cfg(not(feature = "std"))]
pub trait Read { pub trait Read {
fn read(&mut self, buf: &mut [u8]) -> Result<usize>; fn read(&mut self, buf: &mut [u8]) -> Result<usize>;
fn bytes(self) -> Bytes<Self> fn bytes(self) -> Bytes<Self>
@ -173,14 +140,10 @@ pub trait Read {
} }
} }
#[cfg(feature = "std")]
pub use std::io::Bytes;
#[cfg(not(feature = "std"))]
pub struct Bytes<R> { pub struct Bytes<R> {
inner: R, inner: R,
} }
#[cfg(not(feature = "std"))]
impl<R: Read> Iterator for Bytes<R> { impl<R: Read> Iterator for Bytes<R> {
type Item = Result<u8>; type Item = Result<u8>;

19
src/io/mod.rs Normal file
View File

@ -0,0 +1,19 @@
//! A tiny, `no_std`-friendly facade around `std::io`.
//! Reexports types from `std` when available; otherwise reimplements and
//! provides some of the core logic.
//!
//! The main reason that `std::io` hasn't found itself reexported as part of
//! the `core` crate is the `std::io::{Read, Write}` traits' reliance on
//! `std::io::Error`, which may contain internally a heap-allocated `Box<Error>`
//! and/or now relying on OS-specific `std::backtrace::Backtrace`.
pub use self::imp::{Bytes, Error, ErrorKind, Read, Result, Write};
mod core;
mod imp {
#[cfg(not(feature = "std"))]
pub use super::core::*;
#[cfg(feature = "std")]
pub use std::io::*;
}