mod.rs - source
Description: Source of the Rust file `library/std/src/io/buffered/mod.rs`.
Keywords: rust, rustlang, rust-lang

      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
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151

    //! Buffering wrappers for I/O traits

    mod bufreader;
    mod bufwriter;
    mod linewriter;
    mod linewritershim;

    #[cfg(test)]
    mod tests;

    use crate::error;
    use crate::fmt;
    use crate::io::Error;

    pub use bufreader::BufReader;
    pub use bufwriter::BufWriter;
    pub use linewriter::LineWriter;
    use linewritershim::LineWriterShim;

    /// An error returned by [`BufWriter::into_inner`] which combines an error that
    /// happened while writing out the buffer, and the buffered writer object
    /// which may be used to recover from the condition.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use std::io::BufWriter;
    /// use std::net::TcpStream;
    ///
    /// let mut stream = BufWriter::new(TcpStream::connect("127.0.0.1:34254").unwrap());
    ///
    /// // do stuff with the stream
    ///
    /// // we want to get our `TcpStream` back, so let's try:
    ///
    /// let stream = match stream.into_inner() {
    ///     Ok(s) => s,
    ///     Err(e) => {
    ///         // Here, e is an IntoInnerError
    ///         panic!("An error occurred");
    ///     }
    /// };
    /// ```
    #[derive(Debug)]
    #[stable(feature = "rust1", since = "1.0.0")]
    pub struct IntoInnerError<W>(W, Error);

    impl<W> IntoInnerError<W> {
        /// Construct a new IntoInnerError
        fn new(writer: W, error: Error) -> Self {
            Self(writer, error)
        }

        /// Helper to construct a new IntoInnerError; intended to help with
        /// adapters that wrap other adapters
        fn new_wrapped<W2>(self, f: impl FnOnce(W) -> W2) -> IntoInnerError<W2> {
            let Self(writer, error) = self;
            IntoInnerError::new(f(writer), error)
        }

        /// Returns the error which caused the call to [`BufWriter::into_inner()`]
        /// to fail.
        ///
        /// This error was returned when attempting to write the internal buffer.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::io::BufWriter;
        /// use std::net::TcpStream;
        ///
        /// let mut stream = BufWriter::new(TcpStream::connect("127.0.0.1:34254").unwrap());
        ///
        /// // do stuff with the stream
        ///
        /// // we want to get our `TcpStream` back, so let's try:
        ///
        /// let stream = match stream.into_inner() {
        ///     Ok(s) => s,
        ///     Err(e) => {
        ///         // Here, e is an IntoInnerError, let's log the inner error.
        ///         //
        ///         // We'll just 'log' to stdout for this example.
        ///         println!("{}", e.error());
        ///
        ///         panic!("An unexpected error occurred.");
        ///     }
        /// };
        /// ```
        #[stable(feature = "rust1", since = "1.0.0")]
        pub fn error(&self) -> &Error {
            &self.1
        }

        /// Returns the buffered writer instance which generated the error.
        ///
        /// The returned object can be used for error recovery, such as
        /// re-inspecting the buffer.
        ///
        /// # Examples
        ///
        /// ```no_run
        /// use std::io::BufWriter;
        /// use std::net::TcpStream;
        ///
        /// let mut stream = BufWriter::new(TcpStream::connect("127.0.0.1:34254").unwrap());
        ///
        /// // do stuff with the stream
        ///
        /// // we want to get our `TcpStream` back, so let's try:
        ///
        /// let stream = match stream.into_inner() {
        ///     Ok(s) => s,
        ///     Err(e) => {
        ///         // Here, e is an IntoInnerError, let's re-examine the buffer:
        ///         let buffer = e.into_inner();
        ///
        ///         // do stuff to try to recover
        ///
        ///         // afterwards, let's just return the stream
        ///         buffer.into_inner().unwrap()
        ///     }
        /// };
        /// ```
        #[stable(feature = "rust1", since = "1.0.0")]
        pub fn into_inner(self) -> W {
            self.0
        }
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<W> From<IntoInnerError<W>> for Error {
        fn from(iie: IntoInnerError<W>) -> Error {
            iie.1
        }
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<W: Send + fmt::Debug> error::Error for IntoInnerError<W> {
        #[allow(deprecated, deprecated_in_future)]
        fn description(&self) -> &str {
            error::Error::description(self.error())
        }
    }

    #[stable(feature = "rust1", since = "1.0.0")]
    impl<W> fmt::Display for IntoInnerError<W> {
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            self.error().fmt(f)
        }
    }