devela/sys/io/
namespace.rs

Help
1// devela::sys::io::namespace
2//
3//! `Io` namespace.
4//
5
6#[cfg(not(feature = "std"))]
7use super::{io_copy as copy, io_empty as empty, io_repeat as repeat};
8use crate::{IoEmpty, IoRead, IoRepeat, IoResult, IoWrite};
9#[cfg(feature = "std")]
10use crate::{
11    IoSink, Stderr, Stdin, Stdout, String,
12    _dep::_std::io::{copy, empty, read_to_string, repeat, sink, stderr, stdin, stdout},
13};
14
15#[doc = crate::TAG_NAMESPACE!()]
16/// I/O-related operations.
17pub struct Io;
18
19/// # Methods available in `no_std`.
20#[rustfmt::skip]
21impl Io {
22    #[cfg(not(feature = "std"))]
23    /// Copies the entire contents of a reader into a writer.
24    ///
25    /// See <https://doc.rust-lang.org/std/io/fn.copy.html>.
26    ///
27    /// # Features
28    /// Makes use of the `unsafe_array` feature to employ [`MaybeUninit`].
29    pub fn copy<R, W, const LEN: usize>(reader: &mut R, writer: &mut W) -> IoResult<u64>
30    where R: IoRead + ?Sized, W: IoWrite + ?Sized { copy::<R, W, LEN>(reader, writer) }
31    #[cfg(feature = "std")]
32    /// Copies the entire contents of a reader into a writer.
33    ///
34    /// See `std::io::`[`copy`].
35    pub fn copy<R, W>(reader: &mut R, writer: &mut W) -> IoResult<u64>
36    where R: IoRead + ?Sized, W: IoWrite + ?Sized { copy(reader, writer) }
37
38    /// Creates a value that is always at EOF for reads, and ignores all data written.
39    ///
40    /// See `std::io::`[`empty`].
41    #[must_use]
42    pub const fn empty() -> IoEmpty { empty() }
43
44    /// Creates an instance of a reader that infinitely repeats one byte.
45    ///
46    /// See `std::io::`[`repeat`].
47    #[must_use]
48    pub const fn repeat(byte: u8) -> IoRepeat { repeat(byte) }
49}
50
51/// # Methods only available in `std`.
52#[rustfmt::skip]
53#[cfg(feature = "std")]
54#[cfg_attr(feature = "nightly_doc", doc(cfg(feature = "std")))]
55impl Io {
56    /// Reads all bytes from a reader into a new String.
57    ///
58    /// See `std::io::`[`read_to_string`].
59    pub fn read_to_string<R: IoRead>(reader: R) -> IoResult<String> { read_to_string(reader) }
60
61    /// Creates an instance of a writer which will successfully consume all data.
62    ///
63    /// See `std::io::`[`sink`].
64    pub const fn sink() -> IoSink { sink() }
65
66    /// Constructs a new handle to the standard error of the current process.
67    ///
68    /// See `std::io::`[`stderr`].
69    pub fn stderr() -> Stderr { stderr() }
70
71    /// Constructs a new handle to the standard input of the current process.
72    ///
73    /// See `std::io::`[`stdin`].
74    pub fn stdin() -> Stdin { stdin() }
75
76    /// Constructs a new handle to the standard output of the current process.
77    ///
78    /// See `std::io::`[`stdout`].
79    pub fn stdout() -> Stdout { stdout() }
80}
devela/sys/io/namespace.rs

devela/sys/io/
namespace.rs
