1 // Copyright 2013-2014 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 // ignore-lexer-test FIXME #15883
13 // FIXME: cover these topics:
14 // path, reader, writer, stream, raii (close not needed),
15 // stdio, print!, println!, file access, process spawning,
19 //! I/O, including files, networking, timers, and processes
21 //! > **Warning**: This module is currently called `old_io` for a reason! The
22 //! > module is currently being redesigned in a number of RFCs. For more details
23 //! > follow the RFC repository in connection with [RFC 517][base] or follow
24 //! > some of these sub-RFCs
26 //! > * [String handling][osstr]
27 //! > * [Core I/O support][core]
28 //! > * [Deadlines][deadlines]
29 //! > * [std::env][env]
30 //! > * [std::process][process]
32 //! [base]: https://github.com/rust-lang/rfcs/blob/master/text/0517-io-os-reform.md
33 //! [osstr]: https://github.com/rust-lang/rfcs/pull/575
34 //! [core]: https://github.com/rust-lang/rfcs/pull/576
35 //! [deadlines]: https://github.com/rust-lang/rfcs/pull/577
36 //! [env]: https://github.com/rust-lang/rfcs/pull/578
37 //! [process]: https://github.com/rust-lang/rfcs/pull/579
39 //! `std::io` provides Rust's basic I/O types,
40 //! for reading and writing to files, TCP, UDP,
41 //! and other types of sockets and pipes,
42 //! manipulating the file system, spawning processes.
46 //! Some examples of obvious things you might want to do
48 //! * Read lines from stdin
51 //! use std::old_io as io;
53 //! let mut stdin = io::stdin();
54 //! for line in stdin.lock().lines() {
55 //! print!("{}", line.unwrap());
59 //! * Read a complete file
62 //! use std::old_io::File;
64 //! let contents = File::open(&Path::new("message.txt")).read_to_end();
67 //! * Write a line to a file
70 //! # #![allow(unused_must_use)]
71 //! use std::old_io::File;
73 //! let mut file = File::create(&Path::new("message.txt"));
74 //! file.write_all(b"hello, file!\n");
76 //! # ::std::old_io::fs::unlink(&Path::new("message.txt"));
79 //! * Iterate over the lines of a file
82 //! use std::old_io::BufferedReader;
83 //! use std::old_io::File;
85 //! let path = Path::new("message.txt");
86 //! let mut file = BufferedReader::new(File::open(&path));
87 //! for line in file.lines() {
88 //! print!("{}", line.unwrap());
92 //! * Pull the lines of a file into a vector of strings
95 //! use std::old_io::BufferedReader;
96 //! use std::old_io::File;
98 //! let path = Path::new("message.txt");
99 //! let mut file = BufferedReader::new(File::open(&path));
100 //! let lines: Vec<String> = file.lines().map(|x| x.unwrap()).collect();
103 //! * Make a simple TCP client connection and request
106 //! # #![allow(unused_must_use)]
107 //! use std::old_io::TcpStream;
109 //! # // connection doesn't fail if a server is running on 8080
110 //! # // locally, we still want to be type checking this code, so lets
111 //! # // just stop it running (#11576)
113 //! let mut socket = TcpStream::connect("127.0.0.1:8080").unwrap();
114 //! socket.write_all(b"GET / HTTP/1.0\n\n");
115 //! let response = socket.read_to_end();
119 //! * Make a simple TCP server
124 //! # #![allow(dead_code)]
125 //! use std::old_io::{TcpListener, TcpStream};
126 //! use std::old_io::{Acceptor, Listener};
129 //! let listener = TcpListener::bind("127.0.0.1:80");
131 //! // bind the listener to the specified address
132 //! let mut acceptor = listener.listen();
134 //! fn handle_client(mut stream: TcpStream) {
136 //! # &mut stream; // silence unused mutability/variable warning
138 //! // accept connections and process them, spawning a new tasks for each one
139 //! for stream in acceptor.incoming() {
141 //! Err(e) => { /* connection failed */ }
143 //! thread::spawn(move|| {
144 //! // connection succeeded
145 //! handle_client(stream)
151 //! // close the socket server
159 //! I/O is an area where nearly every operation can result in unexpected
160 //! errors. Errors should be painfully visible when they happen, and handling them
161 //! should be easy to work with. It should be convenient to handle specific I/O
162 //! errors, and it should also be convenient to not deal with I/O errors.
164 //! Rust's I/O employs a combination of techniques to reduce boilerplate
165 //! while still providing feedback about errors. The basic strategy:
167 //! * All I/O operations return `IoResult<T>` which is equivalent to
168 //! `Result<T, IoError>`. The `Result` type is defined in the `std::result`
170 //! * If the `Result` type goes unused, then the compiler will by default emit a
171 //! warning about the unused result. This is because `Result` has the
172 //! `#[must_use]` attribute.
173 //! * Common traits are implemented for `IoResult`, e.g.
174 //! `impl<R: Reader> Reader for IoResult<R>`, so that error values do not have
175 //! to be 'unwrapped' before use.
177 //! These features combine in the API to allow for expressions like
178 //! `File::create(&Path::new("diary.txt")).write_all(b"Met a girl.\n")`
179 //! without having to worry about whether "diary.txt" exists or whether
180 //! the write succeeds. As written, if either `new` or `write_line`
181 //! encounters an error then the result of the entire expression will
184 //! If you wanted to handle the error though you might write:
187 //! # #![allow(unused_must_use)]
188 //! use std::old_io::File;
190 //! match File::create(&Path::new("diary.txt")).write_all(b"Met a girl.\n") {
191 //! Ok(()) => (), // succeeded
192 //! Err(e) => println!("failed to write to my diary: {}", e),
195 //! # ::std::old_io::fs::unlink(&Path::new("diary.txt"));
198 //! So what actually happens if `create` encounters an error?
199 //! It's important to know that what `new` returns is not a `File`
200 //! but an `IoResult<File>`. If the file does not open, then `new` will simply
201 //! return `Err(..)`. Because there is an implementation of `Writer` (the trait
202 //! required ultimately required for types to implement `write_line`) there is no
203 //! need to inspect or unwrap the `IoResult<File>` and we simply call `write_line`
204 //! on it. If `new` returned an `Err(..)` then the followup call to `write_line`
205 //! will also return an error.
209 //! Explicit pattern matching on `IoResult`s can get quite verbose, especially
210 //! when performing many I/O operations. Some examples (like those above) are
211 //! alleviated with extra methods implemented on `IoResult`, but others have more
212 //! complex interdependencies among each I/O operation.
214 //! The `try!` macro from `std::macros` is provided as a method of early-return
215 //! inside `Result`-returning functions. It expands to an early-return on `Err`
216 //! and otherwise unwraps the contained `Ok` value.
218 //! If you wanted to read several `u32`s from a file and return their product:
221 //! use std::old_io::{File, IoResult};
223 //! fn file_product(p: &Path) -> IoResult<u32> {
224 //! let mut f = File::open(p);
225 //! let x1 = try!(f.read_le_u32());
226 //! let x2 = try!(f.read_le_u32());
231 //! match file_product(&Path::new("numbers.bin")) {
232 //! Ok(x) => println!("{}", x),
233 //! Err(e) => println!("Failed to read numbers!")
237 //! With `try!` in `file_product`, each `read_le_u32` need not be directly
238 //! concerned with error handling; instead its caller is responsible for
239 //! responding to errors that may occur while attempting to read the numbers.
241 #![unstable(feature = "old_io")]
242 #![deny(unused_must_use)]
244 pub use self::SeekStyle::*;
245 pub use self::FileMode::*;
246 pub use self::FileAccess::*;
247 pub use self::IoErrorKind::*;
250 use default::Default;
254 use iter::{Iterator, IteratorExt};
259 use option::Option::{Some, None};
263 use result::Result::{Ok, Err};
274 pub use self::stdio::stdin;
275 pub use self::stdio::stdout;
276 pub use self::stdio::stderr;
277 pub use self::stdio::print;
278 pub use self::stdio::println;
280 pub use self::fs::File;
281 pub use self::timer::Timer;
282 pub use self::net::ip::IpAddr;
283 pub use self::net::tcp::TcpListener;
284 pub use self::net::tcp::TcpStream;
285 pub use self::pipe::PipeStream;
286 pub use self::process::{Process, Command};
287 pub use self::tempfile::TempDir;
289 pub use self::mem::{MemReader, BufReader, MemWriter, BufWriter};
290 pub use self::buffered::{BufferedReader, BufferedWriter, BufferedStream,
292 pub use self::comm_adapters::{ChanReader, ChanWriter};
311 /// The default buffer size for various I/O operations
312 // libuv recommends 64k buffers to maximize throughput
313 // https://groups.google.com/forum/#!topic/libuv/oQO1HJAIDdA
314 const DEFAULT_BUF_SIZE: uint = 1024 * 64;
316 /// A convenient typedef of the return value of any I/O action.
317 pub type IoResult<T> = Result<T, IoError>;
319 /// The type passed to I/O condition handlers to indicate error
323 /// Is something like this sufficient? It's kind of archaic
324 #[derive(PartialEq, Eq, Clone, Debug)]
326 /// An enumeration which can be matched against for determining the flavor
328 pub kind: IoErrorKind,
329 /// A human-readable description about the error
330 pub desc: &'static str,
331 /// Detailed information about this error, not always available
332 pub detail: Option<String>
336 /// Convert an `errno` value into an `IoError`.
338 /// If `detail` is `true`, the `detail` field of the `IoError`
339 /// struct is filled with an allocated string describing the error
340 /// in more detail, retrieved from the operating system.
341 pub fn from_errno(errno: i32, detail: bool) -> IoError {
342 let mut err = sys::decode_error(errno as i32);
343 if detail && err.kind == OtherIoError {
344 err.detail = Some(os::error_string(errno).chars()
345 .map(|c| c.to_lowercase()).collect())
350 /// Retrieve the last error to occur as a (detailed) IoError.
352 /// This uses the OS `errno`, and so there should not be any task
353 /// descheduling or migration (other than that performed by the
354 /// operating system) between the call(s) for which errors are
355 /// being checked and the call of this function.
356 pub fn last_error() -> IoError {
357 IoError::from_errno(os::errno(), true)
361 #[stable(feature = "rust1", since = "1.0.0")]
362 impl fmt::Display for IoError {
363 fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
365 IoError { kind: OtherIoError, desc: "unknown error", detail: Some(ref detail) } =>
366 write!(fmt, "{}", detail),
367 IoError { detail: None, desc, .. } =>
368 write!(fmt, "{}", desc),
369 IoError { detail: Some(ref detail), desc, .. } =>
370 write!(fmt, "{} ({})", desc, detail)
375 impl Error for IoError {
376 fn description(&self) -> &str { self.desc }
379 /// A list specifying general categories of I/O error.
380 #[derive(Copy, PartialEq, Eq, Clone, Debug)]
381 pub enum IoErrorKind {
382 /// Any I/O error not part of this list.
384 /// The operation could not complete because end of file was reached.
386 /// The file was not found.
388 /// The file permissions disallowed access to this file.
390 /// A network connection failed for some reason not specified in this list.
392 /// The network operation failed because the network connection was closed.
394 /// The connection was refused by the remote server.
396 /// The connection was reset by the remote server.
398 /// The connection was aborted (terminated) by the remote server.
400 /// The network operation failed because it was not connected yet.
402 /// The operation failed because a pipe was closed.
404 /// A file already existed with that name.
406 /// No file exists at that location.
408 /// The path did not specify the type of file that this operation required. For example,
409 /// attempting to copy a directory with the `fs::copy()` operation will fail with this error.
410 MismatchedFileTypeForOperation,
411 /// The operation temporarily failed (for example, because a signal was received), and retrying
414 /// No I/O functionality is available for this task.
416 /// A parameter was incorrect in a way that caused an I/O error not part of this list.
418 /// The I/O operation's timeout expired, causing it to be canceled.
420 /// This write operation failed to write all of its data.
422 /// Normally the write() method on a Writer guarantees that all of its data
423 /// has been written, but some operations may be terminated after only
424 /// partially writing some data. An example of this is a timed out write
425 /// which successfully wrote a known number of bytes, but bailed out after
428 /// The payload contained as part of this variant is the number of bytes
429 /// which are known to have been successfully written.
431 /// The Reader returned 0 bytes from `read()` too many times.
435 /// A trait that lets you add a `detail` to an IoError easily
436 trait UpdateIoError<T> {
437 /// Returns an IoError with updated description and detail
438 fn update_err<D>(self, desc: &'static str, detail: D) -> Self where
439 D: FnOnce(&IoError) -> String;
441 /// Returns an IoError with updated detail
442 fn update_detail<D>(self, detail: D) -> Self where
443 D: FnOnce(&IoError) -> String;
445 /// Returns an IoError with update description
446 fn update_desc(self, desc: &'static str) -> Self;
449 impl<T> UpdateIoError<T> for IoResult<T> {
450 fn update_err<D>(self, desc: &'static str, detail: D) -> IoResult<T> where
451 D: FnOnce(&IoError) -> String,
453 self.map_err(move |mut e| {
454 let detail = detail(&e);
456 e.detail = Some(detail);
461 fn update_detail<D>(self, detail: D) -> IoResult<T> where
462 D: FnOnce(&IoError) -> String,
464 self.map_err(move |mut e| { e.detail = Some(detail(&e)); e })
467 fn update_desc(self, desc: &'static str) -> IoResult<T> {
468 self.map_err(|mut e| { e.desc = desc; e })
472 static NO_PROGRESS_LIMIT: uint = 1000;
474 /// A trait for objects which are byte-oriented streams. Readers are defined by
475 /// one method, `read`. This function will block until data is available,
476 /// filling in the provided buffer with any data read.
478 /// Readers are intended to be composable with one another. Many objects
479 /// throughout the I/O and related libraries take and provide types which
480 /// implement the `Reader` trait.
483 // Only method which need to get implemented for this trait
485 /// Read bytes, up to the length of `buf` and place them in `buf`.
486 /// Returns the number of bytes read. The number of bytes read may
487 /// be less than the number requested, even 0. Returns `Err` on EOF.
491 /// If an error occurs during this I/O operation, then it is returned as
492 /// `Err(IoError)`. Note that end-of-file is considered an error, and can be
493 /// inspected for in the error's `kind` field. Also note that reading 0
494 /// bytes is not considered an error in all circumstances
496 /// # Implementation Note
498 /// When implementing this method on a new Reader, you are strongly encouraged
499 /// not to return 0 if you can avoid it.
500 fn read(&mut self, buf: &mut [u8]) -> IoResult<uint>;
502 // Convenient helper methods based on the above methods
504 /// Reads at least `min` bytes and places them in `buf`.
505 /// Returns the number of bytes read.
507 /// This will continue to call `read` until at least `min` bytes have been
508 /// read. If `read` returns 0 too many times, `NoProgress` will be
513 /// If an error occurs at any point, that error is returned, and no further
515 fn read_at_least(&mut self, min: uint, buf: &mut [u8]) -> IoResult<uint> {
518 detail: Some(String::from_str("the buffer is too short")),
519 ..standard_error(InvalidInput)
526 match self.read(&mut buf[read..]) {
529 if zeroes >= NO_PROGRESS_LIMIT {
530 return Err(standard_error(NoProgress));
537 err@Err(_) => return err
544 /// Reads a single byte. Returns `Err` on EOF.
545 fn read_byte(&mut self) -> IoResult<u8> {
547 try!(self.read_at_least(1, &mut buf));
551 /// Reads up to `len` bytes and appends them to a vector.
552 /// Returns the number of bytes read. The number of bytes read may be
553 /// less than the number requested, even 0. Returns Err on EOF.
557 /// If an error occurs during this I/O operation, then it is returned
558 /// as `Err(IoError)`. See `read()` for more details.
559 fn push(&mut self, len: uint, buf: &mut Vec<u8>) -> IoResult<uint> {
560 let start_len = buf.len();
564 let s = unsafe { slice_vec_capacity(buf, start_len, start_len + len) };
567 unsafe { buf.set_len(start_len + n) };
571 /// Reads at least `min` bytes, but no more than `len`, and appends them to
573 /// Returns the number of bytes read.
575 /// This will continue to call `read` until at least `min` bytes have been
576 /// read. If `read` returns 0 too many times, `NoProgress` will be
581 /// If an error occurs at any point, that error is returned, and no further
583 fn push_at_least(&mut self, min: uint, len: uint, buf: &mut Vec<u8>) -> IoResult<uint> {
586 detail: Some(String::from_str("the buffer is too short")),
587 ..standard_error(InvalidInput)
591 let start_len = buf.len();
594 // we can't just use self.read_at_least(min, slice) because we need to push
595 // successful reads onto the vector before any returned errors.
600 let s = unsafe { slice_vec_capacity(buf, start_len + read, start_len + len) };
601 try!(self.read_at_least(1, s))
603 unsafe { buf.set_len(start_len + read) };
608 /// Reads exactly `len` bytes and gives you back a new vector of length
613 /// Fails with the same conditions as `read`. Additionally returns error
614 /// on EOF. Note that if an error is returned, then some number of bytes may
615 /// have already been consumed from the underlying reader, and they are lost
616 /// (not returned as part of the error). If this is unacceptable, then it is
617 /// recommended to use the `push_at_least` or `read` methods.
618 fn read_exact(&mut self, len: uint) -> IoResult<Vec<u8>> {
619 let mut buf = Vec::with_capacity(len);
620 match self.push_at_least(len, len, &mut buf) {
626 /// Reads all remaining bytes from the stream.
630 /// Returns any non-EOF error immediately. Previously read bytes are
631 /// discarded when an error is returned.
633 /// When EOF is encountered, all bytes read up to that point are returned.
634 fn read_to_end(&mut self) -> IoResult<Vec<u8>> {
635 let mut buf = Vec::with_capacity(DEFAULT_BUF_SIZE);
637 match self.push_at_least(1, DEFAULT_BUF_SIZE, &mut buf) {
639 Err(ref e) if e.kind == EndOfFile => break,
640 Err(e) => return Err(e)
646 /// Reads all of the remaining bytes of this stream, interpreting them as a
647 /// UTF-8 encoded stream. The corresponding string is returned.
651 /// This function returns all of the same errors as `read_to_end` with an
652 /// additional error if the reader's contents are not a valid sequence of
654 fn read_to_string(&mut self) -> IoResult<String> {
655 self.read_to_end().and_then(|s| {
656 match String::from_utf8(s) {
658 Err(_) => Err(standard_error(InvalidInput)),
663 // Byte conversion helpers
665 /// Reads `n` little-endian unsigned integer bytes.
667 /// `n` must be between 1 and 8, inclusive.
668 fn read_le_uint_n(&mut self, nbytes: uint) -> IoResult<u64> {
669 assert!(nbytes > 0 && nbytes <= 8);
675 val += (try!(self.read_u8()) as u64) << pos;
682 /// Reads `n` little-endian signed integer bytes.
684 /// `n` must be between 1 and 8, inclusive.
685 fn read_le_int_n(&mut self, nbytes: uint) -> IoResult<i64> {
686 self.read_le_uint_n(nbytes).map(|i| extend_sign(i, nbytes))
689 /// Reads `n` big-endian unsigned integer bytes.
691 /// `n` must be between 1 and 8, inclusive.
692 fn read_be_uint_n(&mut self, nbytes: uint) -> IoResult<u64> {
693 assert!(nbytes > 0 && nbytes <= 8);
699 val += (try!(self.read_u8()) as u64) << i * 8;
704 /// Reads `n` big-endian signed integer bytes.
706 /// `n` must be between 1 and 8, inclusive.
707 fn read_be_int_n(&mut self, nbytes: uint) -> IoResult<i64> {
708 self.read_be_uint_n(nbytes).map(|i| extend_sign(i, nbytes))
711 /// Reads a little-endian unsigned integer.
713 /// The number of bytes returned is system-dependent.
714 fn read_le_uint(&mut self) -> IoResult<uint> {
715 self.read_le_uint_n(usize::BYTES).map(|i| i as uint)
718 /// Reads a little-endian integer.
720 /// The number of bytes returned is system-dependent.
721 fn read_le_int(&mut self) -> IoResult<int> {
722 self.read_le_int_n(isize::BYTES).map(|i| i as int)
725 /// Reads a big-endian unsigned integer.
727 /// The number of bytes returned is system-dependent.
728 fn read_be_uint(&mut self) -> IoResult<uint> {
729 self.read_be_uint_n(usize::BYTES).map(|i| i as uint)
732 /// Reads a big-endian integer.
734 /// The number of bytes returned is system-dependent.
735 fn read_be_int(&mut self) -> IoResult<int> {
736 self.read_be_int_n(isize::BYTES).map(|i| i as int)
739 /// Reads a big-endian `u64`.
741 /// `u64`s are 8 bytes long.
742 fn read_be_u64(&mut self) -> IoResult<u64> {
743 self.read_be_uint_n(8)
746 /// Reads a big-endian `u32`.
748 /// `u32`s are 4 bytes long.
749 fn read_be_u32(&mut self) -> IoResult<u32> {
750 self.read_be_uint_n(4).map(|i| i as u32)
753 /// Reads a big-endian `u16`.
755 /// `u16`s are 2 bytes long.
756 fn read_be_u16(&mut self) -> IoResult<u16> {
757 self.read_be_uint_n(2).map(|i| i as u16)
760 /// Reads a big-endian `i64`.
762 /// `i64`s are 8 bytes long.
763 fn read_be_i64(&mut self) -> IoResult<i64> {
764 self.read_be_int_n(8)
767 /// Reads a big-endian `i32`.
769 /// `i32`s are 4 bytes long.
770 fn read_be_i32(&mut self) -> IoResult<i32> {
771 self.read_be_int_n(4).map(|i| i as i32)
774 /// Reads a big-endian `i16`.
776 /// `i16`s are 2 bytes long.
777 fn read_be_i16(&mut self) -> IoResult<i16> {
778 self.read_be_int_n(2).map(|i| i as i16)
781 /// Reads a big-endian `f64`.
783 /// `f64`s are 8 byte, IEEE754 double-precision floating point numbers.
784 fn read_be_f64(&mut self) -> IoResult<f64> {
785 self.read_be_u64().map(|i| unsafe {
786 transmute::<u64, f64>(i)
790 /// Reads a big-endian `f32`.
792 /// `f32`s are 4 byte, IEEE754 single-precision floating point numbers.
793 fn read_be_f32(&mut self) -> IoResult<f32> {
794 self.read_be_u32().map(|i| unsafe {
795 transmute::<u32, f32>(i)
799 /// Reads a little-endian `u64`.
801 /// `u64`s are 8 bytes long.
802 fn read_le_u64(&mut self) -> IoResult<u64> {
803 self.read_le_uint_n(8)
806 /// Reads a little-endian `u32`.
808 /// `u32`s are 4 bytes long.
809 fn read_le_u32(&mut self) -> IoResult<u32> {
810 self.read_le_uint_n(4).map(|i| i as u32)
813 /// Reads a little-endian `u16`.
815 /// `u16`s are 2 bytes long.
816 fn read_le_u16(&mut self) -> IoResult<u16> {
817 self.read_le_uint_n(2).map(|i| i as u16)
820 /// Reads a little-endian `i64`.
822 /// `i64`s are 8 bytes long.
823 fn read_le_i64(&mut self) -> IoResult<i64> {
824 self.read_le_int_n(8)
827 /// Reads a little-endian `i32`.
829 /// `i32`s are 4 bytes long.
830 fn read_le_i32(&mut self) -> IoResult<i32> {
831 self.read_le_int_n(4).map(|i| i as i32)
834 /// Reads a little-endian `i16`.
836 /// `i16`s are 2 bytes long.
837 fn read_le_i16(&mut self) -> IoResult<i16> {
838 self.read_le_int_n(2).map(|i| i as i16)
841 /// Reads a little-endian `f64`.
843 /// `f64`s are 8 byte, IEEE754 double-precision floating point numbers.
844 fn read_le_f64(&mut self) -> IoResult<f64> {
845 self.read_le_u64().map(|i| unsafe {
846 transmute::<u64, f64>(i)
850 /// Reads a little-endian `f32`.
852 /// `f32`s are 4 byte, IEEE754 single-precision floating point numbers.
853 fn read_le_f32(&mut self) -> IoResult<f32> {
854 self.read_le_u32().map(|i| unsafe {
855 transmute::<u32, f32>(i)
861 /// `u8`s are 1 byte.
862 fn read_u8(&mut self) -> IoResult<u8> {
868 /// `i8`s are 1 byte.
869 fn read_i8(&mut self) -> IoResult<i8> {
870 self.read_byte().map(|i| i as i8)
874 /// A reader which can be converted to a RefReader.
875 pub trait ByRefReader {
876 /// Creates a wrapper around a mutable reference to the reader.
878 /// This is useful to allow applying adaptors while still
879 /// retaining ownership of the original value.
880 fn by_ref<'a>(&'a mut self) -> RefReader<'a, Self>;
883 impl<T: Reader> ByRefReader for T {
884 fn by_ref<'a>(&'a mut self) -> RefReader<'a, T> {
885 RefReader { inner: self }
889 /// A reader which can be converted to bytes.
890 pub trait BytesReader {
891 /// Create an iterator that reads a single byte on
892 /// each iteration, until EOF.
896 /// Any error other than `EndOfFile` that is produced by the underlying Reader
897 /// is returned by the iterator and should be handled by the caller.
898 fn bytes<'r>(&'r mut self) -> extensions::Bytes<'r, Self>;
901 impl<T: Reader> BytesReader for T {
902 fn bytes<'r>(&'r mut self) -> extensions::Bytes<'r, T> {
903 extensions::Bytes::new(self)
907 impl<'a> Reader for Box<Reader+'a> {
908 fn read(&mut self, buf: &mut [u8]) -> IoResult<uint> {
909 let reader: &mut Reader = &mut **self;
914 impl<'a> Reader for &'a mut (Reader+'a) {
915 fn read(&mut self, buf: &mut [u8]) -> IoResult<uint> { (*self).read(buf) }
918 /// Returns a slice of `v` between `start` and `end`.
920 /// Similar to `slice()` except this function only bounds the slice on the
921 /// capacity of `v`, not the length.
925 /// Panics when `start` or `end` point outside the capacity of `v`, or when
927 // Private function here because we aren't sure if we want to expose this as
928 // API yet. If so, it should be a method on Vec.
929 unsafe fn slice_vec_capacity<'a, T>(v: &'a mut Vec<T>, start: uint, end: uint) -> &'a mut [T] {
933 assert!(start <= end);
934 assert!(end <= v.capacity());
936 data: v.as_ptr().offset(start as int),
941 /// A `RefReader` is a struct implementing `Reader` which contains a reference
942 /// to another reader. This is often useful when composing streams.
947 /// use std::old_io as io;
948 /// use std::old_io::ByRefReader;
949 /// use std::old_io::util::LimitReader;
951 /// fn process_input<R: Reader>(r: R) {}
953 /// let mut stream = io::stdin();
955 /// // Only allow the function to process at most one kilobyte of input
957 /// let stream = LimitReader::new(stream.by_ref(), 1024);
958 /// process_input(stream);
961 /// // 'stream' is still available for use here
963 pub struct RefReader<'a, R:'a> {
964 /// The underlying reader which this is referencing
968 impl<'a, R: Reader> Reader for RefReader<'a, R> {
969 fn read(&mut self, buf: &mut [u8]) -> IoResult<uint> { self.inner.read(buf) }
972 impl<'a, R: Buffer> Buffer for RefReader<'a, R> {
973 fn fill_buf(&mut self) -> IoResult<&[u8]> { self.inner.fill_buf() }
974 fn consume(&mut self, amt: uint) { self.inner.consume(amt) }
977 fn extend_sign(val: u64, nbytes: uint) -> i64 {
978 let shift = (8 - nbytes) * 8;
979 (val << shift) as i64 >> shift
982 /// A trait for objects which are byte-oriented streams. Writers are defined by
983 /// one method, `write`. This function will block until the provided buffer of
984 /// bytes has been entirely written, and it will return any failures which occur.
986 /// Another commonly overridden method is the `flush` method for writers such as
987 /// buffered writers.
989 /// Writers are intended to be composable with one another. Many objects
990 /// throughout the I/O and related libraries take and provide types which
991 /// implement the `Writer` trait.
993 /// Write the entirety of a given buffer
997 /// If an error happens during the I/O operation, the error is returned as
998 /// `Err`. Note that it is considered an error if the entire buffer could
999 /// not be written, and if an error is returned then it is unknown how much
1000 /// data (if any) was actually written.
1001 fn write_all(&mut self, buf: &[u8]) -> IoResult<()>;
1003 /// Deprecated, this method was renamed to `write_all`
1004 #[unstable(feature = "io")]
1005 #[deprecated(since = "1.0.0", reason = "renamed to `write_all`")]
1006 fn write(&mut self, buf: &[u8]) -> IoResult<()> { self.write_all(buf) }
1008 /// Flush this output stream, ensuring that all intermediately buffered
1009 /// contents reach their destination.
1011 /// This is by default a no-op and implementers of the `Writer` trait should
1012 /// decide whether their stream needs to be buffered or not.
1013 fn flush(&mut self) -> IoResult<()> { Ok(()) }
1015 /// Writes a formatted string into this writer, returning any error
1018 /// This method is primarily used to interface with the `format_args!`
1019 /// macro, but it is rare that this should explicitly be called. The
1020 /// `write!` macro should be favored to invoke this method instead.
1024 /// This function will return any I/O error reported while formatting.
1025 fn write_fmt(&mut self, fmt: fmt::Arguments) -> IoResult<()> {
1026 // Create a shim which translates a Writer to a fmt::Write and saves
1027 // off I/O errors. instead of discarding them
1028 struct Adaptor<'a, T: ?Sized +'a> {
1030 error: IoResult<()>,
1033 impl<'a, T: ?Sized + Writer> fmt::Write for Adaptor<'a, T> {
1034 fn write_str(&mut self, s: &str) -> fmt::Result {
1035 match self.inner.write_all(s.as_bytes()) {
1038 self.error = Err(e);
1045 let mut output = Adaptor { inner: self, error: Ok(()) };
1046 match fmt::write(&mut output, fmt) {
1048 Err(..) => output.error
1053 /// Write a rust string into this sink.
1055 /// The bytes written will be the UTF-8 encoded version of the input string.
1056 /// If other encodings are desired, it is recommended to compose this stream
1057 /// with another performing the conversion, or to use `write` with a
1058 /// converted byte-array instead.
1060 fn write_str(&mut self, s: &str) -> IoResult<()> {
1061 self.write_all(s.as_bytes())
1064 /// Writes a string into this sink, and then writes a literal newline (`\n`)
1065 /// byte afterwards. Note that the writing of the newline is *not* atomic in
1066 /// the sense that the call to `write` is invoked twice (once with the
1067 /// string and once with a newline character).
1069 /// If other encodings or line ending flavors are desired, it is recommended
1070 /// that the `write` method is used specifically instead.
1072 fn write_line(&mut self, s: &str) -> IoResult<()> {
1073 self.write_str(s).and_then(|()| self.write_all(&[b'\n']))
1076 /// Write a single char, encoded as UTF-8.
1078 fn write_char(&mut self, c: char) -> IoResult<()> {
1079 let mut buf = [0u8; 4];
1080 let n = c.encode_utf8(&mut buf).unwrap_or(0);
1081 self.write_all(&buf[..n])
1084 /// Write the result of passing n through `int::to_str_bytes`.
1086 fn write_int(&mut self, n: int) -> IoResult<()> {
1087 write!(self, "{}", n)
1090 /// Write the result of passing n through `uint::to_str_bytes`.
1092 fn write_uint(&mut self, n: uint) -> IoResult<()> {
1093 write!(self, "{}", n)
1096 /// Write a little-endian uint (number of bytes depends on system).
1098 fn write_le_uint(&mut self, n: uint) -> IoResult<()> {
1099 extensions::u64_to_le_bytes(n as u64, usize::BYTES, |v| self.write_all(v))
1102 /// Write a little-endian int (number of bytes depends on system).
1104 fn write_le_int(&mut self, n: int) -> IoResult<()> {
1105 extensions::u64_to_le_bytes(n as u64, isize::BYTES, |v| self.write_all(v))
1108 /// Write a big-endian uint (number of bytes depends on system).
1110 fn write_be_uint(&mut self, n: uint) -> IoResult<()> {
1111 extensions::u64_to_be_bytes(n as u64, usize::BYTES, |v| self.write_all(v))
1114 /// Write a big-endian int (number of bytes depends on system).
1116 fn write_be_int(&mut self, n: int) -> IoResult<()> {
1117 extensions::u64_to_be_bytes(n as u64, isize::BYTES, |v| self.write_all(v))
1120 /// Write a big-endian u64 (8 bytes).
1122 fn write_be_u64(&mut self, n: u64) -> IoResult<()> {
1123 extensions::u64_to_be_bytes(n, 8, |v| self.write_all(v))
1126 /// Write a big-endian u32 (4 bytes).
1128 fn write_be_u32(&mut self, n: u32) -> IoResult<()> {
1129 extensions::u64_to_be_bytes(n as u64, 4, |v| self.write_all(v))
1132 /// Write a big-endian u16 (2 bytes).
1134 fn write_be_u16(&mut self, n: u16) -> IoResult<()> {
1135 extensions::u64_to_be_bytes(n as u64, 2, |v| self.write_all(v))
1138 /// Write a big-endian i64 (8 bytes).
1140 fn write_be_i64(&mut self, n: i64) -> IoResult<()> {
1141 extensions::u64_to_be_bytes(n as u64, 8, |v| self.write_all(v))
1144 /// Write a big-endian i32 (4 bytes).
1146 fn write_be_i32(&mut self, n: i32) -> IoResult<()> {
1147 extensions::u64_to_be_bytes(n as u64, 4, |v| self.write_all(v))
1150 /// Write a big-endian i16 (2 bytes).
1152 fn write_be_i16(&mut self, n: i16) -> IoResult<()> {
1153 extensions::u64_to_be_bytes(n as u64, 2, |v| self.write_all(v))
1156 /// Write a big-endian IEEE754 double-precision floating-point (8 bytes).
1158 fn write_be_f64(&mut self, f: f64) -> IoResult<()> {
1160 self.write_be_u64(transmute(f))
1164 /// Write a big-endian IEEE754 single-precision floating-point (4 bytes).
1166 fn write_be_f32(&mut self, f: f32) -> IoResult<()> {
1168 self.write_be_u32(transmute(f))
1172 /// Write a little-endian u64 (8 bytes).
1174 fn write_le_u64(&mut self, n: u64) -> IoResult<()> {
1175 extensions::u64_to_le_bytes(n, 8, |v| self.write_all(v))
1178 /// Write a little-endian u32 (4 bytes).
1180 fn write_le_u32(&mut self, n: u32) -> IoResult<()> {
1181 extensions::u64_to_le_bytes(n as u64, 4, |v| self.write_all(v))
1184 /// Write a little-endian u16 (2 bytes).
1186 fn write_le_u16(&mut self, n: u16) -> IoResult<()> {
1187 extensions::u64_to_le_bytes(n as u64, 2, |v| self.write_all(v))
1190 /// Write a little-endian i64 (8 bytes).
1192 fn write_le_i64(&mut self, n: i64) -> IoResult<()> {
1193 extensions::u64_to_le_bytes(n as u64, 8, |v| self.write_all(v))
1196 /// Write a little-endian i32 (4 bytes).
1198 fn write_le_i32(&mut self, n: i32) -> IoResult<()> {
1199 extensions::u64_to_le_bytes(n as u64, 4, |v| self.write_all(v))
1202 /// Write a little-endian i16 (2 bytes).
1204 fn write_le_i16(&mut self, n: i16) -> IoResult<()> {
1205 extensions::u64_to_le_bytes(n as u64, 2, |v| self.write_all(v))
1208 /// Write a little-endian IEEE754 double-precision floating-point
1211 fn write_le_f64(&mut self, f: f64) -> IoResult<()> {
1213 self.write_le_u64(transmute(f))
1217 /// Write a little-endian IEEE754 single-precision floating-point
1220 fn write_le_f32(&mut self, f: f32) -> IoResult<()> {
1222 self.write_le_u32(transmute(f))
1226 /// Write a u8 (1 byte).
1228 fn write_u8(&mut self, n: u8) -> IoResult<()> {
1229 self.write_all(&[n])
1232 /// Write an i8 (1 byte).
1234 fn write_i8(&mut self, n: i8) -> IoResult<()> {
1235 self.write_all(&[n as u8])
1239 /// A writer which can be converted to a RefWriter.
1240 pub trait ByRefWriter {
1241 /// Creates a wrapper around a mutable reference to the writer.
1243 /// This is useful to allow applying wrappers while still
1244 /// retaining ownership of the original value.
1246 fn by_ref<'a>(&'a mut self) -> RefWriter<'a, Self>;
1249 impl<T: Writer> ByRefWriter for T {
1250 fn by_ref<'a>(&'a mut self) -> RefWriter<'a, T> {
1251 RefWriter { inner: self }
1255 impl<'a> Writer for Box<Writer+'a> {
1257 fn write_all(&mut self, buf: &[u8]) -> IoResult<()> {
1258 (&mut **self).write_all(buf)
1262 fn flush(&mut self) -> IoResult<()> {
1263 (&mut **self).flush()
1267 impl<'a> Writer for &'a mut (Writer+'a) {
1269 fn write_all(&mut self, buf: &[u8]) -> IoResult<()> { (**self).write_all(buf) }
1272 fn flush(&mut self) -> IoResult<()> { (**self).flush() }
1275 /// A `RefWriter` is a struct implementing `Writer` which contains a reference
1276 /// to another writer. This is often useful when composing streams.
1281 /// use std::old_io::util::TeeReader;
1282 /// use std::old_io::{stdin, ByRefWriter};
1284 /// fn process_input<R: Reader>(r: R) {}
1286 /// let mut output = Vec::new();
1289 /// // Don't give ownership of 'output' to the 'tee'. Instead we keep a
1290 /// // handle to it in the outer scope
1291 /// let mut tee = TeeReader::new(stdin(), output.by_ref());
1292 /// process_input(tee);
1295 /// println!("input processed: {:?}", output);
1297 pub struct RefWriter<'a, W:'a> {
1298 /// The underlying writer which this is referencing
1302 impl<'a, W: Writer> Writer for RefWriter<'a, W> {
1304 fn write_all(&mut self, buf: &[u8]) -> IoResult<()> { self.inner.write_all(buf) }
1307 fn flush(&mut self) -> IoResult<()> { self.inner.flush() }
1311 /// A Stream is a readable and a writable object. Data written is typically
1312 /// received by the object which reads receive data from.
1313 pub trait Stream: Reader + Writer { }
1315 impl<T: Reader + Writer> Stream for T {}
1317 /// An iterator that reads a line on each iteration,
1318 /// until `.read_line()` encounters `EndOfFile`.
1320 /// # Notes about the Iteration Protocol
1322 /// The `Lines` may yield `None` and thus terminate
1323 /// an iteration, but continue to yield elements if iteration
1324 /// is attempted again.
1328 /// Any error other than `EndOfFile` that is produced by the underlying Reader
1329 /// is returned by the iterator and should be handled by the caller.
1330 pub struct Lines<'r, T:'r> {
1334 impl<'r, T: Buffer> Iterator for Lines<'r, T> {
1335 type Item = IoResult<String>;
1337 fn next(&mut self) -> Option<IoResult<String>> {
1338 match self.buffer.read_line() {
1339 Ok(x) => Some(Ok(x)),
1340 Err(IoError { kind: EndOfFile, ..}) => None,
1341 Err(y) => Some(Err(y))
1346 /// An iterator that reads a utf8-encoded character on each iteration,
1347 /// until `.read_char()` encounters `EndOfFile`.
1349 /// # Notes about the Iteration Protocol
1351 /// The `Chars` may yield `None` and thus terminate
1352 /// an iteration, but continue to yield elements if iteration
1353 /// is attempted again.
1357 /// Any error other than `EndOfFile` that is produced by the underlying Reader
1358 /// is returned by the iterator and should be handled by the caller.
1359 pub struct Chars<'r, T:'r> {
1363 impl<'r, T: Buffer> Iterator for Chars<'r, T> {
1364 type Item = IoResult<char>;
1366 fn next(&mut self) -> Option<IoResult<char>> {
1367 match self.buffer.read_char() {
1368 Ok(x) => Some(Ok(x)),
1369 Err(IoError { kind: EndOfFile, ..}) => None,
1370 Err(y) => Some(Err(y))
1375 /// A Buffer is a type of reader which has some form of internal buffering to
1376 /// allow certain kinds of reading operations to be more optimized than others.
1377 /// This type extends the `Reader` trait with a few methods that are not
1378 /// possible to reasonably implement with purely a read interface.
1379 pub trait Buffer: Reader {
1380 /// Fills the internal buffer of this object, returning the buffer contents.
1381 /// Note that none of the contents will be "read" in the sense that later
1382 /// calling `read` may return the same contents.
1384 /// The `consume` function must be called with the number of bytes that are
1385 /// consumed from this buffer returned to ensure that the bytes are never
1390 /// This function will return an I/O error if the underlying reader was
1391 /// read, but returned an error. Note that it is not an error to return a
1392 /// 0-length buffer.
1393 fn fill_buf<'a>(&'a mut self) -> IoResult<&'a [u8]>;
1395 /// Tells this buffer that `amt` bytes have been consumed from the buffer,
1396 /// so they should no longer be returned in calls to `read`.
1397 fn consume(&mut self, amt: uint);
1399 /// Reads the next line of input, interpreted as a sequence of UTF-8
1400 /// encoded Unicode codepoints. If a newline is encountered, then the
1401 /// newline is contained in the returned string.
1406 /// use std::old_io::BufReader;
1408 /// let mut reader = BufReader::new(b"hello\nworld");
1409 /// assert_eq!("hello\n", &*reader.read_line().unwrap());
1414 /// This function has the same error semantics as `read_until`:
1416 /// * All non-EOF errors will be returned immediately
1417 /// * If an error is returned previously consumed bytes are lost
1418 /// * EOF is only returned if no bytes have been read
1419 /// * Reach EOF may mean that the delimiter is not present in the return
1422 /// Additionally, this function can fail if the line of input read is not a
1423 /// valid UTF-8 sequence of bytes.
1424 fn read_line(&mut self) -> IoResult<String> {
1425 self.read_until(b'\n').and_then(|line|
1426 match String::from_utf8(line) {
1428 Err(_) => Err(standard_error(InvalidInput)),
1433 /// Reads a sequence of bytes leading up to a specified delimiter. Once the
1434 /// specified byte is encountered, reading ceases and the bytes up to and
1435 /// including the delimiter are returned.
1439 /// If any I/O error is encountered other than EOF, the error is immediately
1440 /// returned. Note that this may discard bytes which have already been read,
1441 /// and those bytes will *not* be returned. It is recommended to use other
1442 /// methods if this case is worrying.
1444 /// If EOF is encountered, then this function will return EOF if 0 bytes
1445 /// have been read, otherwise the pending byte buffer is returned. This
1446 /// is the reason that the byte buffer returned may not always contain the
1448 fn read_until(&mut self, byte: u8) -> IoResult<Vec<u8>> {
1449 let mut res = Vec::new();
1452 let (done, used) = {
1453 let available = match self.fill_buf() {
1455 Err(ref e) if res.len() > 0 && e.kind == EndOfFile => {
1458 Err(e) => return Err(e)
1460 match available.iter().position(|&b| b == byte) {
1462 res.push_all(&available[..i + 1]);
1466 res.push_all(available);
1467 (false, available.len())
1478 /// Reads the next utf8-encoded character from the underlying stream.
1482 /// If an I/O error occurs, or EOF, then this function will return `Err`.
1483 /// This function will also return error if the stream does not contain a
1484 /// valid utf-8 encoded codepoint as the next few bytes in the stream.
1485 fn read_char(&mut self) -> IoResult<char> {
1486 let first_byte = try!(self.read_byte());
1487 let width = unicode::str::utf8_char_width(first_byte);
1488 if width == 1 { return Ok(first_byte as char) }
1489 if width == 0 { return Err(standard_error(InvalidInput)) } // not utf8
1490 let mut buf = [first_byte, 0, 0, 0];
1493 while start < width {
1494 match try!(self.read(&mut buf[start .. width])) {
1495 n if n == width - start => break,
1496 n if n < width - start => { start += n; }
1497 _ => return Err(standard_error(InvalidInput)),
1501 match str::from_utf8(&buf[..width]).ok() {
1502 Some(s) => Ok(s.char_at(0)),
1503 None => Err(standard_error(InvalidInput))
1508 /// Extension methods for the Buffer trait which are included in the prelude.
1509 pub trait BufferPrelude {
1510 /// Create an iterator that reads a utf8-encoded character on each iteration
1515 /// Any error other than `EndOfFile` that is produced by the underlying Reader
1516 /// is returned by the iterator and should be handled by the caller.
1517 fn chars<'r>(&'r mut self) -> Chars<'r, Self>;
1519 /// Create an iterator that reads a line on each iteration until EOF.
1523 /// Any error other than `EndOfFile` that is produced by the underlying Reader
1524 /// is returned by the iterator and should be handled by the caller.
1525 fn lines<'r>(&'r mut self) -> Lines<'r, Self>;
1528 impl<T: Buffer> BufferPrelude for T {
1529 fn chars<'r>(&'r mut self) -> Chars<'r, T> {
1530 Chars { buffer: self }
1533 fn lines<'r>(&'r mut self) -> Lines<'r, T> {
1534 Lines { buffer: self }
1538 /// When seeking, the resulting cursor is offset from a base by the offset given
1539 /// to the `seek` function. The base used is specified by this enumeration.
1541 pub enum SeekStyle {
1542 /// Seek from the beginning of the stream
1544 /// Seek from the end of the stream
1546 /// Seek from the current position
1550 /// An object implementing `Seek` internally has some form of cursor which can
1551 /// be moved within a stream of bytes. The stream typically has a fixed size,
1552 /// allowing seeking relative to either end.
1554 /// Return position of file cursor in the stream
1555 fn tell(&self) -> IoResult<u64>;
1557 /// Seek to an offset in a stream
1559 /// A successful seek clears the EOF indicator. Seeking beyond EOF is
1560 /// allowed, but seeking before position 0 is not allowed.
1564 /// * Seeking to a negative offset is considered an error
1565 /// * Seeking past the end of the stream does not modify the underlying
1566 /// stream, but the next write may cause the previous data to be filled in
1567 /// with a bit pattern.
1568 fn seek(&mut self, pos: i64, style: SeekStyle) -> IoResult<()>;
1571 /// A listener is a value that can consume itself to start listening for
1574 /// Doing so produces some sort of Acceptor.
1575 pub trait Listener<T, A: Acceptor<T>> {
1576 /// Spin up the listener and start queuing incoming connections
1580 /// Returns `Err` if this listener could not be bound to listen for
1581 /// connections. In all cases, this listener is consumed.
1582 fn listen(self) -> IoResult<A>;
1585 /// An acceptor is a value that presents incoming connections
1586 pub trait Acceptor<T> {
1587 /// Wait for and accept an incoming connection
1591 /// Returns `Err` if an I/O error is encountered.
1592 fn accept(&mut self) -> IoResult<T>;
1594 /// Create an iterator over incoming connection attempts.
1596 /// Note that I/O errors will be yielded by the iterator itself.
1597 fn incoming<'r>(&'r mut self) -> IncomingConnections<'r, Self> {
1598 IncomingConnections { inc: self }
1602 /// An infinite iterator over incoming connection attempts.
1603 /// Calling `next` will block the task until a connection is attempted.
1605 /// Since connection attempts can continue forever, this iterator always returns
1606 /// `Some`. The `Some` contains the `IoResult` representing whether the
1607 /// connection attempt was successful. A successful connection will be wrapped
1608 /// in `Ok`. A failed connection is represented as an `Err`.
1609 pub struct IncomingConnections<'a, A: ?Sized +'a> {
1614 impl<'a, T, A: ?Sized + Acceptor<T>> Iterator for IncomingConnections<'a, A> {
1615 type Item = IoResult<T>;
1617 fn next(&mut self) -> Option<IoResult<T>> {
1618 Some(self.inc.accept())
1622 /// Creates a standard error for a commonly used flavor of error. The `detail`
1623 /// field of the returned error will always be `None`.
1628 /// use std::old_io as io;
1630 /// let eof = io::standard_error(io::EndOfFile);
1631 /// let einval = io::standard_error(io::InvalidInput);
1633 pub fn standard_error(kind: IoErrorKind) -> IoError {
1634 let desc = match kind {
1635 EndOfFile => "end of file",
1636 IoUnavailable => "I/O is unavailable",
1637 InvalidInput => "invalid input",
1638 OtherIoError => "unknown I/O error",
1639 FileNotFound => "file not found",
1640 PermissionDenied => "permission denied",
1641 ConnectionFailed => "connection failed",
1642 Closed => "stream is closed",
1643 ConnectionRefused => "connection refused",
1644 ConnectionReset => "connection reset",
1645 ConnectionAborted => "connection aborted",
1646 NotConnected => "not connected",
1647 BrokenPipe => "broken pipe",
1648 PathAlreadyExists => "file already exists",
1649 PathDoesntExist => "no such file",
1650 MismatchedFileTypeForOperation => "mismatched file type",
1651 ResourceUnavailable => "resource unavailable",
1652 TimedOut => "operation timed out",
1653 ShortWrite(..) => "short write",
1654 NoProgress => "no progress",
1663 /// A mode specifies how a file should be opened or created. These modes are
1664 /// passed to `File::open_mode` and are used to control where the file is
1665 /// positioned when it is initially opened.
1666 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
1668 /// Opens a file positioned at the beginning.
1670 /// Opens a file positioned at EOF.
1672 /// Opens a file, truncating it if it already exists.
1676 /// Access permissions with which the file should be opened. `File`s
1677 /// opened with `Read` will return an error if written to.
1678 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
1679 pub enum FileAccess {
1680 /// Read-only access, requests to write will result in an error
1682 /// Write-only access, requests to read will result in an error
1684 /// Read-write access, no requests are denied by default
1688 /// Different kinds of files which can be identified by a call to stat
1689 #[derive(Copy, PartialEq, Debug, Hash, Clone)]
1691 /// This is a normal file, corresponding to `S_IFREG`
1694 /// This file is a directory, corresponding to `S_IFDIR`
1697 /// This file is a named pipe, corresponding to `S_IFIFO`
1700 /// This file is a block device, corresponding to `S_IFBLK`
1703 /// This file is a symbolic link to another file, corresponding to `S_IFLNK`
1706 /// The type of this file is not recognized as one of the other categories
1710 /// A structure used to describe metadata information about a file. This
1711 /// structure is created through the `stat` method on a `Path`.
1717 /// use std::old_io::fs::PathExtensions;
1719 /// let info = match Path::new("foo.txt").stat() {
1720 /// Ok(stat) => stat,
1721 /// Err(e) => panic!("couldn't read foo.txt: {}", e),
1724 /// println!("byte size: {}", info.size);
1726 #[derive(Copy, Hash)]
1727 pub struct FileStat {
1728 /// The size of the file, in bytes
1730 /// The kind of file this path points to (directory, file, pipe, etc.)
1732 /// The file permissions currently on the file
1733 pub perm: FilePermission,
1735 // FIXME(#10301): These time fields are pretty useless without an actual
1736 // time representation, what are the milliseconds relative
1739 /// The time that the file was created at, in platform-dependent
1742 /// The time that this file was last modified, in platform-dependent
1745 /// The time that this file was last accessed, in platform-dependent
1749 /// Information returned by stat() which is not guaranteed to be
1750 /// platform-independent. This information may be useful on some platforms,
1751 /// but it may have different meanings or no meaning at all on other
1754 /// Usage of this field is discouraged, but if access is desired then the
1755 /// fields are located here.
1756 #[unstable(feature = "io")]
1757 pub unstable: UnstableFileStat,
1760 /// This structure represents all of the possible information which can be
1761 /// returned from a `stat` syscall which is not contained in the `FileStat`
1762 /// structure. This information is not necessarily platform independent, and may
1763 /// have different meanings or no meaning at all on some platforms.
1764 #[unstable(feature = "io")]
1765 #[derive(Copy, Hash)]
1766 pub struct UnstableFileStat {
1767 /// The ID of the device containing the file.
1769 /// The file serial number.
1773 /// The number of hard links to this file.
1775 /// The user ID of the file.
1777 /// The group ID of the file.
1779 /// The optimal block size for I/O.
1781 /// The blocks allocated for this file.
1783 /// User-defined flags for the file.
1785 /// The file generation number.
1791 /// A set of permissions for a file or directory is represented by a set of
1792 /// flags which are or'd together.
1794 flags FilePermission: u32 {
1795 const USER_READ = 0o400,
1796 const USER_WRITE = 0o200,
1797 const USER_EXECUTE = 0o100,
1798 const GROUP_READ = 0o040,
1799 const GROUP_WRITE = 0o020,
1800 const GROUP_EXECUTE = 0o010,
1801 const OTHER_READ = 0o004,
1802 const OTHER_WRITE = 0o002,
1803 const OTHER_EXECUTE = 0o001,
1805 const USER_RWX = USER_READ.bits | USER_WRITE.bits | USER_EXECUTE.bits,
1806 const GROUP_RWX = GROUP_READ.bits | GROUP_WRITE.bits | GROUP_EXECUTE.bits,
1807 const OTHER_RWX = OTHER_READ.bits | OTHER_WRITE.bits | OTHER_EXECUTE.bits,
1809 /// Permissions for user owned files, equivalent to 0644 on unix-like
1811 const USER_FILE = USER_READ.bits | USER_WRITE.bits | GROUP_READ.bits | OTHER_READ.bits,
1813 /// Permissions for user owned directories, equivalent to 0755 on
1814 /// unix-like systems.
1815 const USER_DIR = USER_RWX.bits | GROUP_READ.bits | GROUP_EXECUTE.bits |
1816 OTHER_READ.bits | OTHER_EXECUTE.bits,
1818 /// Permissions for user owned executables, equivalent to 0755
1819 /// on unix-like systems.
1820 const USER_EXEC = USER_DIR.bits,
1822 /// All possible permissions enabled.
1823 const ALL_PERMISSIONS = USER_RWX.bits | GROUP_RWX.bits | OTHER_RWX.bits,
1828 #[stable(feature = "rust1", since = "1.0.0")]
1829 impl Default for FilePermission {
1830 #[stable(feature = "rust1", since = "1.0.0")]
1832 fn default() -> FilePermission { FilePermission::empty() }
1835 #[stable(feature = "rust1", since = "1.0.0")]
1836 impl fmt::Display for FilePermission {
1837 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1838 write!(f, "{:04o}", self.bits)
1844 use self::BadReaderBehavior::*;
1845 use super::{IoResult, Reader, MemReader, NoProgress, InvalidInput, Writer};
1846 use prelude::v1::{Ok, Vec, Buffer, SliceExt};
1849 #[derive(Clone, PartialEq, Debug)]
1850 enum BadReaderBehavior {
1855 struct BadReader<T> {
1857 behavior: Vec<BadReaderBehavior>,
1860 impl<T: Reader> BadReader<T> {
1861 fn new(r: T, behavior: Vec<BadReaderBehavior>) -> BadReader<T> {
1862 BadReader { behavior: behavior, r: r }
1866 impl<T: Reader> Reader for BadReader<T> {
1867 fn read(&mut self, buf: &mut [u8]) -> IoResult<uint> {
1868 let BadReader { ref mut behavior, ref mut r } = *self;
1870 if behavior.is_empty() {
1871 // fall back on good
1874 match (&mut **behavior)[0] {
1875 GoodBehavior(0) => (),
1876 GoodBehavior(ref mut x) => {
1880 BadBehavior(0) => (),
1881 BadBehavior(ref mut x) => {
1892 fn test_read_at_least() {
1893 let mut r = BadReader::new(MemReader::new(b"hello, world!".to_vec()),
1894 vec![GoodBehavior(usize::MAX)]);
1895 let buf = &mut [0u8; 5];
1896 assert!(r.read_at_least(1, buf).unwrap() >= 1);
1897 assert!(r.read_exact(5).unwrap().len() == 5); // read_exact uses read_at_least
1898 assert!(r.read_at_least(0, buf).is_ok());
1900 let mut r = BadReader::new(MemReader::new(b"hello, world!".to_vec()),
1901 vec![BadBehavior(50), GoodBehavior(usize::MAX)]);
1902 assert!(r.read_at_least(1, buf).unwrap() >= 1);
1904 let mut r = BadReader::new(MemReader::new(b"hello, world!".to_vec()),
1905 vec![BadBehavior(1), GoodBehavior(1),
1906 BadBehavior(50), GoodBehavior(usize::MAX)]);
1907 assert!(r.read_at_least(1, buf).unwrap() >= 1);
1908 assert!(r.read_at_least(1, buf).unwrap() >= 1);
1910 let mut r = BadReader::new(MemReader::new(b"hello, world!".to_vec()),
1911 vec![BadBehavior(usize::MAX)]);
1912 assert_eq!(r.read_at_least(1, buf).unwrap_err().kind, NoProgress);
1914 let mut r = MemReader::new(b"hello, world!".to_vec());
1915 assert_eq!(r.read_at_least(5, buf).unwrap(), 5);
1916 assert_eq!(r.read_at_least(6, buf).unwrap_err().kind, InvalidInput);
1920 fn test_push_at_least() {
1921 let mut r = BadReader::new(MemReader::new(b"hello, world!".to_vec()),
1922 vec![GoodBehavior(usize::MAX)]);
1923 let mut buf = Vec::new();
1924 assert!(r.push_at_least(1, 5, &mut buf).unwrap() >= 1);
1925 assert!(r.push_at_least(0, 5, &mut buf).is_ok());
1927 let mut r = BadReader::new(MemReader::new(b"hello, world!".to_vec()),
1928 vec![BadBehavior(50), GoodBehavior(usize::MAX)]);
1929 assert!(r.push_at_least(1, 5, &mut buf).unwrap() >= 1);
1931 let mut r = BadReader::new(MemReader::new(b"hello, world!".to_vec()),
1932 vec![BadBehavior(1), GoodBehavior(1),
1933 BadBehavior(50), GoodBehavior(usize::MAX)]);
1934 assert!(r.push_at_least(1, 5, &mut buf).unwrap() >= 1);
1935 assert!(r.push_at_least(1, 5, &mut buf).unwrap() >= 1);
1937 let mut r = BadReader::new(MemReader::new(b"hello, world!".to_vec()),
1938 vec![BadBehavior(usize::MAX)]);
1939 assert_eq!(r.push_at_least(1, 5, &mut buf).unwrap_err().kind, NoProgress);
1941 let mut r = MemReader::new(b"hello, world!".to_vec());
1942 assert_eq!(r.push_at_least(5, 1, &mut buf).unwrap_err().kind, InvalidInput);
1949 assert_eq!(format!("{}", USER_READ), "0400");
1950 assert_eq!(format!("{}", USER_FILE), "0644");
1951 assert_eq!(format!("{}", USER_EXEC), "0755");
1952 assert_eq!(format!("{}", USER_RWX), "0700");
1953 assert_eq!(format!("{}", GROUP_RWX), "0070");
1954 assert_eq!(format!("{}", OTHER_RWX), "0007");
1955 assert_eq!(format!("{}", ALL_PERMISSIONS), "0777");
1956 assert_eq!(format!("{}", USER_READ | USER_WRITE | OTHER_WRITE), "0602");
1959 fn _ensure_buffer_is_object_safe<T: Buffer>(x: &T) -> &Buffer {