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 `std::io` provides Rust's basic I/O types,
22 for reading and writing to files, TCP, UDP,
23 and other types of sockets and pipes,
24 manipulating the file system, spawning processes and signal handling.
28 Some examples of obvious things you might want to do
30 * Read lines from stdin
35 for line in io::stdin().lines() {
36 print!("{}", line.unwrap());
40 * Read a complete file
45 let contents = File::open(&Path::new("message.txt")).read_to_end();
48 * Write a line to a file
51 # #![allow(unused_must_use)]
54 let mut file = File::create(&Path::new("message.txt"));
55 file.write(b"hello, file!\n");
57 # ::std::io::fs::unlink(&Path::new("message.txt"));
60 * Iterate over the lines of a file
63 use std::io::BufferedReader;
66 let path = Path::new("message.txt");
67 let mut file = BufferedReader::new(File::open(&path));
68 for line in file.lines() {
69 print!("{}", line.unwrap());
73 * Pull the lines of a file into a vector of strings
76 use std::io::BufferedReader;
79 let path = Path::new("message.txt");
80 let mut file = BufferedReader::new(File::open(&path));
81 let lines: Vec<String> = file.lines().map(|x| x.unwrap()).collect();
84 * Make a simple TCP client connection and request
87 # #![allow(unused_must_use)]
88 use std::io::TcpStream;
90 # // connection doesn't fail if a server is running on 8080
91 # // locally, we still want to be type checking this code, so lets
92 # // just stop it running (#11576)
94 let mut socket = TcpStream::connect("127.0.0.1", 8080).unwrap();
95 socket.write(b"GET / HTTP/1.0\n\n");
96 let response = socket.read_to_end();
100 * Make a simple TCP server
105 # #![allow(dead_code)]
106 use std::io::{TcpListener, TcpStream};
107 use std::io::{Acceptor, Listener};
109 let listener = TcpListener::bind("127.0.0.1", 80);
111 // bind the listener to the specified address
112 let mut acceptor = listener.listen();
114 fn handle_client(mut stream: TcpStream) {
116 # &mut stream; // silence unused mutability/variable warning
118 // accept connections and process them, spawning a new tasks for each one
119 for stream in acceptor.incoming() {
121 Err(e) => { /* connection failed */ }
122 Ok(stream) => spawn(proc() {
123 // connection succeeded
124 handle_client(stream)
129 // close the socket server
137 I/O is an area where nearly every operation can result in unexpected
138 errors. Errors should be painfully visible when they happen, and handling them
139 should be easy to work with. It should be convenient to handle specific I/O
140 errors, and it should also be convenient to not deal with I/O errors.
142 Rust's I/O employs a combination of techniques to reduce boilerplate
143 while still providing feedback about errors. The basic strategy:
145 * All I/O operations return `IoResult<T>` which is equivalent to
146 `Result<T, IoError>`. The `Result` type is defined in the `std::result`
148 * If the `Result` type goes unused, then the compiler will by default emit a
149 warning about the unused result. This is because `Result` has the
150 `#[must_use]` attribute.
151 * Common traits are implemented for `IoResult`, e.g.
152 `impl<R: Reader> Reader for IoResult<R>`, so that error values do not have
153 to be 'unwrapped' before use.
155 These features combine in the API to allow for expressions like
156 `File::create(&Path::new("diary.txt")).write(b"Met a girl.\n")`
157 without having to worry about whether "diary.txt" exists or whether
158 the write succeeds. As written, if either `new` or `write_line`
159 encounters an error then the result of the entire expression will
162 If you wanted to handle the error though you might write:
165 # #![allow(unused_must_use)]
168 match File::create(&Path::new("diary.txt")).write(b"Met a girl.\n") {
169 Ok(()) => (), // succeeded
170 Err(e) => println!("failed to write to my diary: {}", e),
173 # ::std::io::fs::unlink(&Path::new("diary.txt"));
176 So what actually happens if `create` encounters an error?
177 It's important to know that what `new` returns is not a `File`
178 but an `IoResult<File>`. If the file does not open, then `new` will simply
179 return `Err(..)`. Because there is an implementation of `Writer` (the trait
180 required ultimately required for types to implement `write_line`) there is no
181 need to inspect or unwrap the `IoResult<File>` and we simply call `write_line`
182 on it. If `new` returned an `Err(..)` then the followup call to `write_line`
183 will also return an error.
187 Explicit pattern matching on `IoResult`s can get quite verbose, especially
188 when performing many I/O operations. Some examples (like those above) are
189 alleviated with extra methods implemented on `IoResult`, but others have more
190 complex interdependencies among each I/O operation.
192 The `try!` macro from `std::macros` is provided as a method of early-return
193 inside `Result`-returning functions. It expands to an early-return on `Err`
194 and otherwise unwraps the contained `Ok` value.
196 If you wanted to read several `u32`s from a file and return their product:
199 use std::io::{File, IoResult};
201 fn file_product(p: &Path) -> IoResult<u32> {
202 let mut f = File::open(p);
203 let x1 = try!(f.read_le_u32());
204 let x2 = try!(f.read_le_u32());
209 match file_product(&Path::new("numbers.bin")) {
210 Ok(x) => println!("{}", x),
211 Err(e) => println!("Failed to read numbers!")
215 With `try!` in `file_product`, each `read_le_u32` need not be directly
216 concerned with error handling; instead its caller is responsible for
217 responding to errors that may occur while attempting to read the numbers.
222 #![deny(unused_must_use)]
225 use collections::Collection;
226 use default::Default;
232 use ops::{BitOr, BitAnd, Sub, Not};
233 use option::{Option, Some, None};
236 use result::{Ok, Err, Result};
238 use slice::{Slice, MutableSlice, ImmutableSlice};
239 use str::{Str, StrSlice};
243 use unicode::char::UnicodeChar;
247 pub use self::stdio::stdin;
248 pub use self::stdio::stdout;
249 pub use self::stdio::stderr;
250 pub use self::stdio::print;
251 pub use self::stdio::println;
253 pub use self::fs::File;
254 pub use self::timer::Timer;
255 pub use self::net::ip::IpAddr;
256 pub use self::net::tcp::TcpListener;
257 pub use self::net::tcp::TcpStream;
258 pub use self::net::udp::UdpStream;
259 pub use self::pipe::PipeStream;
260 pub use self::process::{Process, Command};
261 pub use self::tempfile::TempDir;
263 pub use self::mem::{MemReader, BufReader, MemWriter, BufWriter};
264 pub use self::buffered::{BufferedReader, BufferedWriter, BufferedStream,
266 pub use self::comm_adapters::{ChanReader, ChanWriter};
268 // this comes first to get the iotest! macro
286 /// The default buffer size for various I/O operations
287 // libuv recommends 64k buffers to maximize throughput
288 // https://groups.google.com/forum/#!topic/libuv/oQO1HJAIDdA
289 static DEFAULT_BUF_SIZE: uint = 1024 * 64;
291 /// A convenient typedef of the return value of any I/O action.
292 pub type IoResult<T> = Result<T, IoError>;
294 /// The type passed to I/O condition handlers to indicate error
298 /// Is something like this sufficient? It's kind of archaic
299 #[deriving(PartialEq, Eq, Clone)]
301 /// An enumeration which can be matched against for determining the flavor
303 pub kind: IoErrorKind,
304 /// A human-readable description about the error
305 pub desc: &'static str,
306 /// Detailed information about this error, not always available
307 pub detail: Option<String>
311 /// Convert an `errno` value into an `IoError`.
313 /// If `detail` is `true`, the `detail` field of the `IoError`
314 /// struct is filled with an allocated string describing the error
315 /// in more detail, retrieved from the operating system.
316 pub fn from_errno(errno: uint, detail: bool) -> IoError {
319 fn get_err(errno: i32) -> (IoErrorKind, &'static str) {
321 libc::EOF => (EndOfFile, "end of file"),
322 libc::ERROR_NO_DATA => (BrokenPipe, "the pipe is being closed"),
323 libc::ERROR_FILE_NOT_FOUND => (FileNotFound, "file not found"),
324 libc::ERROR_INVALID_NAME => (InvalidInput, "invalid file name"),
325 libc::WSAECONNREFUSED => (ConnectionRefused, "connection refused"),
326 libc::WSAECONNRESET => (ConnectionReset, "connection reset"),
327 libc::ERROR_ACCESS_DENIED | libc::WSAEACCES =>
328 (PermissionDenied, "permission denied"),
329 libc::WSAEWOULDBLOCK => {
330 (ResourceUnavailable, "resource temporarily unavailable")
332 libc::WSAENOTCONN => (NotConnected, "not connected"),
333 libc::WSAECONNABORTED => (ConnectionAborted, "connection aborted"),
334 libc::WSAEADDRNOTAVAIL => (ConnectionRefused, "address not available"),
335 libc::WSAEADDRINUSE => (ConnectionRefused, "address in use"),
336 libc::ERROR_BROKEN_PIPE => (EndOfFile, "the pipe has ended"),
337 libc::ERROR_OPERATION_ABORTED =>
338 (TimedOut, "operation timed out"),
339 libc::WSAEINVAL => (InvalidInput, "invalid argument"),
340 libc::ERROR_CALL_NOT_IMPLEMENTED =>
341 (IoUnavailable, "function not implemented"),
342 libc::ERROR_INVALID_HANDLE =>
343 (MismatchedFileTypeForOperation,
344 "invalid handle provided to function"),
345 libc::ERROR_NOTHING_TO_TERMINATE =>
346 (InvalidInput, "no process to kill"),
348 // libuv maps this error code to EISDIR. we do too. if it is found
349 // to be incorrect, we can add in some more machinery to only
350 // return this message when ERROR_INVALID_FUNCTION after certain
352 libc::ERROR_INVALID_FUNCTION => (InvalidInput,
353 "illegal operation on a directory"),
355 _ => (OtherIoError, "unknown error")
360 fn get_err(errno: i32) -> (IoErrorKind, &'static str) {
361 // FIXME: this should probably be a bit more descriptive...
363 libc::EOF => (EndOfFile, "end of file"),
364 libc::ECONNREFUSED => (ConnectionRefused, "connection refused"),
365 libc::ECONNRESET => (ConnectionReset, "connection reset"),
366 libc::EPERM | libc::EACCES =>
367 (PermissionDenied, "permission denied"),
368 libc::EPIPE => (BrokenPipe, "broken pipe"),
369 libc::ENOTCONN => (NotConnected, "not connected"),
370 libc::ECONNABORTED => (ConnectionAborted, "connection aborted"),
371 libc::EADDRNOTAVAIL => (ConnectionRefused, "address not available"),
372 libc::EADDRINUSE => (ConnectionRefused, "address in use"),
373 libc::ENOENT => (FileNotFound, "no such file or directory"),
374 libc::EISDIR => (InvalidInput, "illegal operation on a directory"),
375 libc::ENOSYS => (IoUnavailable, "function not implemented"),
376 libc::EINVAL => (InvalidInput, "invalid argument"),
378 (MismatchedFileTypeForOperation,
379 "file descriptor is not a TTY"),
380 libc::ETIMEDOUT => (TimedOut, "operation timed out"),
381 libc::ECANCELED => (TimedOut, "operation aborted"),
383 // These two constants can have the same value on some systems,
384 // but different values on others, so we can't use a match
386 x if x == libc::EAGAIN || x == libc::EWOULDBLOCK =>
387 (ResourceUnavailable, "resource temporarily unavailable"),
389 _ => (OtherIoError, "unknown error")
393 let (kind, desc) = get_err(errno as i32);
397 detail: if detail && kind == OtherIoError {
398 Some(os::error_string(errno).as_slice().chars().map(|c| c.to_lowercase()).collect())
405 /// Retrieve the last error to occur as a (detailed) IoError.
407 /// This uses the OS `errno`, and so there should not be any task
408 /// descheduling or migration (other than that performed by the
409 /// operating system) between the call(s) for which errors are
410 /// being checked and the call of this function.
411 pub fn last_error() -> IoError {
412 IoError::from_errno(os::errno() as uint, true)
415 fn from_rtio_error(err: rtio::IoError) -> IoError {
416 let rtio::IoError { code, extra, detail } = err;
417 let mut ioerr = IoError::from_errno(code, false);
418 ioerr.detail = detail;
419 ioerr.kind = match ioerr.kind {
420 TimedOut if extra > 0 => ShortWrite(extra),
427 impl fmt::Show for IoError {
428 fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
430 IoError { kind: OtherIoError, desc: "unknown error", detail: Some(ref detail) } =>
431 write!(fmt, "{}", detail),
432 IoError { detail: None, desc, .. } =>
433 write!(fmt, "{}", desc),
434 IoError { detail: Some(ref detail), desc, .. } =>
435 write!(fmt, "{} ({})", desc, detail)
440 /// A list specifying general categories of I/O error.
441 #[deriving(PartialEq, Eq, Clone, Show)]
442 pub enum IoErrorKind {
443 /// Any I/O error not part of this list.
445 /// The operation could not complete because end of file was reached.
447 /// The file was not found.
449 /// The file permissions disallowed access to this file.
451 /// A network connection failed for some reason not specified in this list.
453 /// The network operation failed because the network connection was closed.
455 /// The connection was refused by the remote server.
457 /// The connection was reset by the remote server.
459 /// The connection was aborted (terminated) by the remote server.
461 /// The network operation failed because it was not connected yet.
463 /// The operation failed because a pipe was closed.
465 /// A file already existed with that name.
467 /// No file exists at that location.
469 /// The path did not specify the type of file that this operation required. For example,
470 /// attempting to copy a directory with the `fs::copy()` operation will fail with this error.
471 MismatchedFileTypeForOperation,
472 /// The operation temporarily failed (for example, because a signal was received), and retrying
475 /// No I/O functionality is available for this task.
477 /// A parameter was incorrect in a way that caused an I/O error not part of this list.
479 /// The I/O operation's timeout expired, causing it to be canceled.
481 /// This write operation failed to write all of its data.
483 /// Normally the write() method on a Writer guarantees that all of its data
484 /// has been written, but some operations may be terminated after only
485 /// partially writing some data. An example of this is a timed out write
486 /// which successfully wrote a known number of bytes, but bailed out after
489 /// The payload contained as part of this variant is the number of bytes
490 /// which are known to have been successfully written.
492 /// The Reader returned 0 bytes from `read()` too many times.
496 /// A trait that lets you add a `detail` to an IoError easily
497 trait UpdateIoError<T> {
498 /// Returns an IoError with updated description and detail
499 fn update_err(self, desc: &'static str, detail: |&IoError| -> String) -> Self;
501 /// Returns an IoError with updated detail
502 fn update_detail(self, detail: |&IoError| -> String) -> Self;
504 /// Returns an IoError with update description
505 fn update_desc(self, desc: &'static str) -> Self;
508 impl<T> UpdateIoError<T> for IoResult<T> {
509 fn update_err(self, desc: &'static str, detail: |&IoError| -> String) -> IoResult<T> {
510 self.map_err(|mut e| {
511 let detail = detail(&e);
513 e.detail = Some(detail);
518 fn update_detail(self, detail: |&IoError| -> String) -> IoResult<T> {
519 self.map_err(|mut e| { e.detail = Some(detail(&e)); e })
522 fn update_desc(self, desc: &'static str) -> IoResult<T> {
523 self.map_err(|mut e| { e.desc = desc; e })
527 static NO_PROGRESS_LIMIT: uint = 1000;
529 /// A trait for objects which are byte-oriented streams. Readers are defined by
530 /// one method, `read`. This function will block until data is available,
531 /// filling in the provided buffer with any data read.
533 /// Readers are intended to be composable with one another. Many objects
534 /// throughout the I/O and related libraries take and provide types which
535 /// implement the `Reader` trait.
538 // Only method which need to get implemented for this trait
540 /// Read bytes, up to the length of `buf` and place them in `buf`.
541 /// Returns the number of bytes read. The number of bytes read may
542 /// be less than the number requested, even 0. Returns `Err` on EOF.
546 /// If an error occurs during this I/O operation, then it is returned as
547 /// `Err(IoError)`. Note that end-of-file is considered an error, and can be
548 /// inspected for in the error's `kind` field. Also note that reading 0
549 /// bytes is not considered an error in all circumstances
551 /// # Implementation Note
553 /// When implementing this method on a new Reader, you are strongly encouraged
554 /// not to return 0 if you can avoid it.
555 fn read(&mut self, buf: &mut [u8]) -> IoResult<uint>;
557 // Convenient helper methods based on the above methods
559 /// Reads at least `min` bytes and places them in `buf`.
560 /// Returns the number of bytes read.
562 /// This will continue to call `read` until at least `min` bytes have been
563 /// read. If `read` returns 0 too many times, `NoProgress` will be
568 /// If an error occurs at any point, that error is returned, and no further
570 fn read_at_least(&mut self, min: uint, buf: &mut [u8]) -> IoResult<uint> {
573 detail: Some(String::from_str("the buffer is too short")),
574 ..standard_error(InvalidInput)
581 match self.read(buf.mut_slice_from(read)) {
584 if zeroes >= NO_PROGRESS_LIMIT {
585 return Err(standard_error(NoProgress));
592 err@Err(_) => return err
599 /// Reads a single byte. Returns `Err` on EOF.
600 fn read_byte(&mut self) -> IoResult<u8> {
602 try!(self.read_at_least(1, buf));
606 /// Reads up to `len` bytes and appends them to a vector.
607 /// Returns the number of bytes read. The number of bytes read may be
608 /// less than the number requested, even 0. Returns Err on EOF.
612 /// If an error occurs during this I/O operation, then it is returned
613 /// as `Err(IoError)`. See `read()` for more details.
614 fn push(&mut self, len: uint, buf: &mut Vec<u8>) -> IoResult<uint> {
615 let start_len = buf.len();
616 buf.reserve_additional(len);
619 let s = unsafe { slice_vec_capacity(buf, start_len, start_len + len) };
622 unsafe { buf.set_len(start_len + n) };
626 /// Reads at least `min` bytes, but no more than `len`, and appends them to
628 /// Returns the number of bytes read.
630 /// This will continue to call `read` until at least `min` bytes have been
631 /// read. If `read` returns 0 too many times, `NoProgress` will be
636 /// If an error occurs at any point, that error is returned, and no further
638 fn push_at_least(&mut self, min: uint, len: uint, buf: &mut Vec<u8>) -> IoResult<uint> {
641 detail: Some(String::from_str("the buffer is too short")),
642 ..standard_error(InvalidInput)
646 let start_len = buf.len();
647 buf.reserve_additional(len);
649 // we can't just use self.read_at_least(min, slice) because we need to push
650 // successful reads onto the vector before any returned errors.
655 let s = unsafe { slice_vec_capacity(buf, start_len + read, start_len + len) };
656 try!(self.read_at_least(1, s))
658 unsafe { buf.set_len(start_len + read) };
663 /// Reads exactly `len` bytes and gives you back a new vector of length
668 /// Fails with the same conditions as `read`. Additionally returns error
669 /// on EOF. Note that if an error is returned, then some number of bytes may
670 /// have already been consumed from the underlying reader, and they are lost
671 /// (not returned as part of the error). If this is unacceptable, then it is
672 /// recommended to use the `push_at_least` or `read` methods.
673 fn read_exact(&mut self, len: uint) -> IoResult<Vec<u8>> {
674 let mut buf = Vec::with_capacity(len);
675 match self.push_at_least(len, len, &mut buf) {
681 /// Reads all remaining bytes from the stream.
685 /// Returns any non-EOF error immediately. Previously read bytes are
686 /// discarded when an error is returned.
688 /// When EOF is encountered, all bytes read up to that point are returned.
689 fn read_to_end(&mut self) -> IoResult<Vec<u8>> {
690 let mut buf = Vec::with_capacity(DEFAULT_BUF_SIZE);
692 match self.push_at_least(1, DEFAULT_BUF_SIZE, &mut buf) {
694 Err(ref e) if e.kind == EndOfFile => break,
695 Err(e) => return Err(e)
701 /// Reads all of the remaining bytes of this stream, interpreting them as a
702 /// UTF-8 encoded stream. The corresponding string is returned.
706 /// This function returns all of the same errors as `read_to_end` with an
707 /// additional error if the reader's contents are not a valid sequence of
709 fn read_to_string(&mut self) -> IoResult<String> {
710 self.read_to_end().and_then(|s| {
711 match String::from_utf8(s) {
713 Err(_) => Err(standard_error(InvalidInput)),
718 /// Create an iterator that reads a single byte on
719 /// each iteration, until EOF.
723 /// Any error other than `EndOfFile` that is produced by the underlying Reader
724 /// is returned by the iterator and should be handled by the caller.
725 fn bytes<'r>(&'r mut self) -> extensions::Bytes<'r, Self> {
726 extensions::Bytes::new(self)
729 // Byte conversion helpers
731 /// Reads `n` little-endian unsigned integer bytes.
733 /// `n` must be between 1 and 8, inclusive.
734 fn read_le_uint_n(&mut self, nbytes: uint) -> IoResult<u64> {
735 assert!(nbytes > 0 && nbytes <= 8);
741 val += (try!(self.read_u8()) as u64) << pos;
748 /// Reads `n` little-endian signed integer bytes.
750 /// `n` must be between 1 and 8, inclusive.
751 fn read_le_int_n(&mut self, nbytes: uint) -> IoResult<i64> {
752 self.read_le_uint_n(nbytes).map(|i| extend_sign(i, nbytes))
755 /// Reads `n` big-endian unsigned integer bytes.
757 /// `n` must be between 1 and 8, inclusive.
758 fn read_be_uint_n(&mut self, nbytes: uint) -> IoResult<u64> {
759 assert!(nbytes > 0 && nbytes <= 8);
765 val += (try!(self.read_u8()) as u64) << i * 8;
770 /// Reads `n` big-endian signed integer bytes.
772 /// `n` must be between 1 and 8, inclusive.
773 fn read_be_int_n(&mut self, nbytes: uint) -> IoResult<i64> {
774 self.read_be_uint_n(nbytes).map(|i| extend_sign(i, nbytes))
777 /// Reads a little-endian unsigned integer.
779 /// The number of bytes returned is system-dependent.
780 fn read_le_uint(&mut self) -> IoResult<uint> {
781 self.read_le_uint_n(uint::BYTES).map(|i| i as uint)
784 /// Reads a little-endian integer.
786 /// The number of bytes returned is system-dependent.
787 fn read_le_int(&mut self) -> IoResult<int> {
788 self.read_le_int_n(int::BYTES).map(|i| i as int)
791 /// Reads a big-endian unsigned integer.
793 /// The number of bytes returned is system-dependent.
794 fn read_be_uint(&mut self) -> IoResult<uint> {
795 self.read_be_uint_n(uint::BYTES).map(|i| i as uint)
798 /// Reads a big-endian integer.
800 /// The number of bytes returned is system-dependent.
801 fn read_be_int(&mut self) -> IoResult<int> {
802 self.read_be_int_n(int::BYTES).map(|i| i as int)
805 /// Reads a big-endian `u64`.
807 /// `u64`s are 8 bytes long.
808 fn read_be_u64(&mut self) -> IoResult<u64> {
809 self.read_be_uint_n(8)
812 /// Reads a big-endian `u32`.
814 /// `u32`s are 4 bytes long.
815 fn read_be_u32(&mut self) -> IoResult<u32> {
816 self.read_be_uint_n(4).map(|i| i as u32)
819 /// Reads a big-endian `u16`.
821 /// `u16`s are 2 bytes long.
822 fn read_be_u16(&mut self) -> IoResult<u16> {
823 self.read_be_uint_n(2).map(|i| i as u16)
826 /// Reads a big-endian `i64`.
828 /// `i64`s are 8 bytes long.
829 fn read_be_i64(&mut self) -> IoResult<i64> {
830 self.read_be_int_n(8)
833 /// Reads a big-endian `i32`.
835 /// `i32`s are 4 bytes long.
836 fn read_be_i32(&mut self) -> IoResult<i32> {
837 self.read_be_int_n(4).map(|i| i as i32)
840 /// Reads a big-endian `i16`.
842 /// `i16`s are 2 bytes long.
843 fn read_be_i16(&mut self) -> IoResult<i16> {
844 self.read_be_int_n(2).map(|i| i as i16)
847 /// Reads a big-endian `f64`.
849 /// `f64`s are 8 byte, IEEE754 double-precision floating point numbers.
850 fn read_be_f64(&mut self) -> IoResult<f64> {
851 self.read_be_u64().map(|i| unsafe {
852 transmute::<u64, f64>(i)
856 /// Reads a big-endian `f32`.
858 /// `f32`s are 4 byte, IEEE754 single-precision floating point numbers.
859 fn read_be_f32(&mut self) -> IoResult<f32> {
860 self.read_be_u32().map(|i| unsafe {
861 transmute::<u32, f32>(i)
865 /// Reads a little-endian `u64`.
867 /// `u64`s are 8 bytes long.
868 fn read_le_u64(&mut self) -> IoResult<u64> {
869 self.read_le_uint_n(8)
872 /// Reads a little-endian `u32`.
874 /// `u32`s are 4 bytes long.
875 fn read_le_u32(&mut self) -> IoResult<u32> {
876 self.read_le_uint_n(4).map(|i| i as u32)
879 /// Reads a little-endian `u16`.
881 /// `u16`s are 2 bytes long.
882 fn read_le_u16(&mut self) -> IoResult<u16> {
883 self.read_le_uint_n(2).map(|i| i as u16)
886 /// Reads a little-endian `i64`.
888 /// `i64`s are 8 bytes long.
889 fn read_le_i64(&mut self) -> IoResult<i64> {
890 self.read_le_int_n(8)
893 /// Reads a little-endian `i32`.
895 /// `i32`s are 4 bytes long.
896 fn read_le_i32(&mut self) -> IoResult<i32> {
897 self.read_le_int_n(4).map(|i| i as i32)
900 /// Reads a little-endian `i16`.
902 /// `i16`s are 2 bytes long.
903 fn read_le_i16(&mut self) -> IoResult<i16> {
904 self.read_le_int_n(2).map(|i| i as i16)
907 /// Reads a little-endian `f64`.
909 /// `f64`s are 8 byte, IEEE754 double-precision floating point numbers.
910 fn read_le_f64(&mut self) -> IoResult<f64> {
911 self.read_le_u64().map(|i| unsafe {
912 transmute::<u64, f64>(i)
916 /// Reads a little-endian `f32`.
918 /// `f32`s are 4 byte, IEEE754 single-precision floating point numbers.
919 fn read_le_f32(&mut self) -> IoResult<f32> {
920 self.read_le_u32().map(|i| unsafe {
921 transmute::<u32, f32>(i)
927 /// `u8`s are 1 byte.
928 fn read_u8(&mut self) -> IoResult<u8> {
934 /// `i8`s are 1 byte.
935 fn read_i8(&mut self) -> IoResult<i8> {
936 self.read_byte().map(|i| i as i8)
939 /// Creates a wrapper around a mutable reference to the reader.
941 /// This is useful to allow applying adaptors while still
942 /// retaining ownership of the original value.
943 fn by_ref<'a>(&'a mut self) -> RefReader<'a, Self> {
944 RefReader { inner: self }
948 impl Reader for Box<Reader+'static> {
949 fn read(&mut self, buf: &mut [u8]) -> IoResult<uint> { self.read(buf) }
952 impl<'a> Reader for &'a mut Reader+'a {
953 fn read(&mut self, buf: &mut [u8]) -> IoResult<uint> { self.read(buf) }
956 /// Returns a slice of `v` between `start` and `end`.
958 /// Similar to `slice()` except this function only bounds the slice on the
959 /// capacity of `v`, not the length.
963 /// Fails when `start` or `end` point outside the capacity of `v`, or when
965 // Private function here because we aren't sure if we want to expose this as
966 // API yet. If so, it should be a method on Vec.
967 unsafe fn slice_vec_capacity<'a, T>(v: &'a mut Vec<T>, start: uint, end: uint) -> &'a mut [T] {
971 assert!(start <= end);
972 assert!(end <= v.capacity());
974 data: v.as_ptr().offset(start as int),
979 /// A `RefReader` is a struct implementing `Reader` which contains a reference
980 /// to another reader. This is often useful when composing streams.
986 /// # fn process_input<R: Reader>(r: R) {}
989 /// use std::io::util::LimitReader;
991 /// let mut stream = io::stdin();
993 /// // Only allow the function to process at most one kilobyte of input
995 /// let stream = LimitReader::new(stream.by_ref(), 1024);
996 /// process_input(stream);
999 /// // 'stream' is still available for use here
1003 pub struct RefReader<'a, R:'a> {
1004 /// The underlying reader which this is referencing
1008 impl<'a, R: Reader> Reader for RefReader<'a, R> {
1009 fn read(&mut self, buf: &mut [u8]) -> IoResult<uint> { self.inner.read(buf) }
1012 impl<'a, R: Buffer> Buffer for RefReader<'a, R> {
1013 fn fill_buf<'a>(&'a mut self) -> IoResult<&'a [u8]> { self.inner.fill_buf() }
1014 fn consume(&mut self, amt: uint) { self.inner.consume(amt) }
1017 fn extend_sign(val: u64, nbytes: uint) -> i64 {
1018 let shift = (8 - nbytes) * 8;
1019 (val << shift) as i64 >> shift
1022 /// A trait for objects which are byte-oriented streams. Writers are defined by
1023 /// one method, `write`. This function will block until the provided buffer of
1024 /// bytes has been entirely written, and it will return any failures which occur.
1026 /// Another commonly overridden method is the `flush` method for writers such as
1027 /// buffered writers.
1029 /// Writers are intended to be composable with one another. Many objects
1030 /// throughout the I/O and related libraries take and provide types which
1031 /// implement the `Writer` trait.
1033 /// Write the entirety of a given buffer
1037 /// If an error happens during the I/O operation, the error is returned as
1038 /// `Err`. Note that it is considered an error if the entire buffer could
1039 /// not be written, and if an error is returned then it is unknown how much
1040 /// data (if any) was actually written.
1041 fn write(&mut self, buf: &[u8]) -> IoResult<()>;
1043 /// Flush this output stream, ensuring that all intermediately buffered
1044 /// contents reach their destination.
1046 /// This is by default a no-op and implementers of the `Writer` trait should
1047 /// decide whether their stream needs to be buffered or not.
1048 fn flush(&mut self) -> IoResult<()> { Ok(()) }
1050 /// Writes a formatted string into this writer, returning any error
1053 /// This method is primarily used to interface with the `format_args!`
1054 /// macro, but it is rare that this should explicitly be called. The
1055 /// `write!` macro should be favored to invoke this method instead.
1059 /// This function will return any I/O error reported while formatting.
1060 fn write_fmt(&mut self, fmt: &fmt::Arguments) -> IoResult<()> {
1061 // Create a shim which translates a Writer to a FormatWriter and saves
1062 // off I/O errors. instead of discarding them
1063 struct Adaptor<'a, T:'a> {
1065 error: IoResult<()>,
1068 impl<'a, T: Writer> fmt::FormatWriter for Adaptor<'a, T> {
1069 fn write(&mut self, bytes: &[u8]) -> fmt::Result {
1070 match self.inner.write(bytes) {
1073 self.error = Err(e);
1074 Err(fmt::WriteError)
1080 let mut output = Adaptor { inner: self, error: Ok(()) };
1081 match fmt::write(&mut output, fmt) {
1083 Err(..) => output.error
1087 /// Write a rust string into this sink.
1089 /// The bytes written will be the UTF-8 encoded version of the input string.
1090 /// If other encodings are desired, it is recommended to compose this stream
1091 /// with another performing the conversion, or to use `write` with a
1092 /// converted byte-array instead.
1094 fn write_str(&mut self, s: &str) -> IoResult<()> {
1095 self.write(s.as_bytes())
1098 /// Writes a string into this sink, and then writes a literal newline (`\n`)
1099 /// byte afterwards. Note that the writing of the newline is *not* atomic in
1100 /// the sense that the call to `write` is invoked twice (once with the
1101 /// string and once with a newline character).
1103 /// If other encodings or line ending flavors are desired, it is recommended
1104 /// that the `write` method is used specifically instead.
1106 fn write_line(&mut self, s: &str) -> IoResult<()> {
1107 self.write_str(s).and_then(|()| self.write([b'\n']))
1110 /// Write a single char, encoded as UTF-8.
1112 fn write_char(&mut self, c: char) -> IoResult<()> {
1113 let mut buf = [0u8, ..4];
1114 let n = c.encode_utf8(buf.as_mut_slice()).unwrap_or(0);
1115 self.write(buf.slice_to(n))
1118 /// Write the result of passing n through `int::to_str_bytes`.
1120 fn write_int(&mut self, n: int) -> IoResult<()> {
1121 write!(self, "{:d}", n)
1124 /// Write the result of passing n through `uint::to_str_bytes`.
1126 fn write_uint(&mut self, n: uint) -> IoResult<()> {
1127 write!(self, "{:u}", n)
1130 /// Write a little-endian uint (number of bytes depends on system).
1132 fn write_le_uint(&mut self, n: uint) -> IoResult<()> {
1133 extensions::u64_to_le_bytes(n as u64, uint::BYTES, |v| self.write(v))
1136 /// Write a little-endian int (number of bytes depends on system).
1138 fn write_le_int(&mut self, n: int) -> IoResult<()> {
1139 extensions::u64_to_le_bytes(n as u64, int::BYTES, |v| self.write(v))
1142 /// Write a big-endian uint (number of bytes depends on system).
1144 fn write_be_uint(&mut self, n: uint) -> IoResult<()> {
1145 extensions::u64_to_be_bytes(n as u64, uint::BYTES, |v| self.write(v))
1148 /// Write a big-endian int (number of bytes depends on system).
1150 fn write_be_int(&mut self, n: int) -> IoResult<()> {
1151 extensions::u64_to_be_bytes(n as u64, int::BYTES, |v| self.write(v))
1154 /// Write a big-endian u64 (8 bytes).
1156 fn write_be_u64(&mut self, n: u64) -> IoResult<()> {
1157 extensions::u64_to_be_bytes(n, 8u, |v| self.write(v))
1160 /// Write a big-endian u32 (4 bytes).
1162 fn write_be_u32(&mut self, n: u32) -> IoResult<()> {
1163 extensions::u64_to_be_bytes(n as u64, 4u, |v| self.write(v))
1166 /// Write a big-endian u16 (2 bytes).
1168 fn write_be_u16(&mut self, n: u16) -> IoResult<()> {
1169 extensions::u64_to_be_bytes(n as u64, 2u, |v| self.write(v))
1172 /// Write a big-endian i64 (8 bytes).
1174 fn write_be_i64(&mut self, n: i64) -> IoResult<()> {
1175 extensions::u64_to_be_bytes(n as u64, 8u, |v| self.write(v))
1178 /// Write a big-endian i32 (4 bytes).
1180 fn write_be_i32(&mut self, n: i32) -> IoResult<()> {
1181 extensions::u64_to_be_bytes(n as u64, 4u, |v| self.write(v))
1184 /// Write a big-endian i16 (2 bytes).
1186 fn write_be_i16(&mut self, n: i16) -> IoResult<()> {
1187 extensions::u64_to_be_bytes(n as u64, 2u, |v| self.write(v))
1190 /// Write a big-endian IEEE754 double-precision floating-point (8 bytes).
1192 fn write_be_f64(&mut self, f: f64) -> IoResult<()> {
1194 self.write_be_u64(transmute(f))
1198 /// Write a big-endian IEEE754 single-precision floating-point (4 bytes).
1200 fn write_be_f32(&mut self, f: f32) -> IoResult<()> {
1202 self.write_be_u32(transmute(f))
1206 /// Write a little-endian u64 (8 bytes).
1208 fn write_le_u64(&mut self, n: u64) -> IoResult<()> {
1209 extensions::u64_to_le_bytes(n, 8u, |v| self.write(v))
1212 /// Write a little-endian u32 (4 bytes).
1214 fn write_le_u32(&mut self, n: u32) -> IoResult<()> {
1215 extensions::u64_to_le_bytes(n as u64, 4u, |v| self.write(v))
1218 /// Write a little-endian u16 (2 bytes).
1220 fn write_le_u16(&mut self, n: u16) -> IoResult<()> {
1221 extensions::u64_to_le_bytes(n as u64, 2u, |v| self.write(v))
1224 /// Write a little-endian i64 (8 bytes).
1226 fn write_le_i64(&mut self, n: i64) -> IoResult<()> {
1227 extensions::u64_to_le_bytes(n as u64, 8u, |v| self.write(v))
1230 /// Write a little-endian i32 (4 bytes).
1232 fn write_le_i32(&mut self, n: i32) -> IoResult<()> {
1233 extensions::u64_to_le_bytes(n as u64, 4u, |v| self.write(v))
1236 /// Write a little-endian i16 (2 bytes).
1238 fn write_le_i16(&mut self, n: i16) -> IoResult<()> {
1239 extensions::u64_to_le_bytes(n as u64, 2u, |v| self.write(v))
1242 /// Write a little-endian IEEE754 double-precision floating-point
1245 fn write_le_f64(&mut self, f: f64) -> IoResult<()> {
1247 self.write_le_u64(transmute(f))
1251 /// Write a little-endian IEEE754 single-precision floating-point
1254 fn write_le_f32(&mut self, f: f32) -> IoResult<()> {
1256 self.write_le_u32(transmute(f))
1260 /// Write a u8 (1 byte).
1262 fn write_u8(&mut self, n: u8) -> IoResult<()> {
1266 /// Write an i8 (1 byte).
1268 fn write_i8(&mut self, n: i8) -> IoResult<()> {
1269 self.write([n as u8])
1272 /// Creates a wrapper around a mutable reference to the writer.
1274 /// This is useful to allow applying wrappers while still
1275 /// retaining ownership of the original value.
1277 fn by_ref<'a>(&'a mut self) -> RefWriter<'a, Self> {
1278 RefWriter { inner: self }
1282 impl Writer for Box<Writer+'static> {
1284 fn write(&mut self, buf: &[u8]) -> IoResult<()> { self.write(buf) }
1287 fn flush(&mut self) -> IoResult<()> { self.flush() }
1290 impl<'a> Writer for &'a mut Writer+'a {
1292 fn write(&mut self, buf: &[u8]) -> IoResult<()> { self.write(buf) }
1295 fn flush(&mut self) -> IoResult<()> { self.flush() }
1298 /// A `RefWriter` is a struct implementing `Writer` which contains a reference
1299 /// to another writer. This is often useful when composing streams.
1305 /// # fn process_input<R: Reader>(r: R) {}
1307 /// use std::io::util::TeeReader;
1308 /// use std::io::{stdin, MemWriter};
1310 /// let mut output = MemWriter::new();
1313 /// // Don't give ownership of 'output' to the 'tee'. Instead we keep a
1314 /// // handle to it in the outer scope
1315 /// let mut tee = TeeReader::new(stdin(), output.by_ref());
1316 /// process_input(tee);
1319 /// println!("input processed: {}", output.unwrap());
1322 pub struct RefWriter<'a, W:'a> {
1323 /// The underlying writer which this is referencing
1327 impl<'a, W: Writer> Writer for RefWriter<'a, W> {
1329 fn write(&mut self, buf: &[u8]) -> IoResult<()> { self.inner.write(buf) }
1332 fn flush(&mut self) -> IoResult<()> { self.inner.flush() }
1336 /// A Stream is a readable and a writable object. Data written is typically
1337 /// received by the object which reads receive data from.
1338 pub trait Stream: Reader + Writer { }
1340 impl<T: Reader + Writer> Stream for T {}
1342 /// An iterator that reads a line on each iteration,
1343 /// until `.read_line()` encounters `EndOfFile`.
1345 /// # Notes about the Iteration Protocol
1347 /// The `Lines` may yield `None` and thus terminate
1348 /// an iteration, but continue to yield elements if iteration
1349 /// is attempted again.
1353 /// Any error other than `EndOfFile` that is produced by the underlying Reader
1354 /// is returned by the iterator and should be handled by the caller.
1355 pub struct Lines<'r, T:'r> {
1359 impl<'r, T: Buffer> Iterator<IoResult<String>> for Lines<'r, T> {
1360 fn next(&mut self) -> Option<IoResult<String>> {
1361 match self.buffer.read_line() {
1362 Ok(x) => Some(Ok(x)),
1363 Err(IoError { kind: EndOfFile, ..}) => None,
1364 Err(y) => Some(Err(y))
1369 /// An iterator that reads a utf8-encoded character on each iteration,
1370 /// until `.read_char()` encounters `EndOfFile`.
1372 /// # Notes about the Iteration Protocol
1374 /// The `Chars` may yield `None` and thus terminate
1375 /// an iteration, but continue to yield elements if iteration
1376 /// is attempted again.
1380 /// Any error other than `EndOfFile` that is produced by the underlying Reader
1381 /// is returned by the iterator and should be handled by the caller.
1382 pub struct Chars<'r, T:'r> {
1386 impl<'r, T: Buffer> Iterator<IoResult<char>> for Chars<'r, T> {
1387 fn next(&mut self) -> Option<IoResult<char>> {
1388 match self.buffer.read_char() {
1389 Ok(x) => Some(Ok(x)),
1390 Err(IoError { kind: EndOfFile, ..}) => None,
1391 Err(y) => Some(Err(y))
1396 /// A Buffer is a type of reader which has some form of internal buffering to
1397 /// allow certain kinds of reading operations to be more optimized than others.
1398 /// This type extends the `Reader` trait with a few methods that are not
1399 /// possible to reasonably implement with purely a read interface.
1400 pub trait Buffer: Reader {
1401 /// Fills the internal buffer of this object, returning the buffer contents.
1402 /// Note that none of the contents will be "read" in the sense that later
1403 /// calling `read` may return the same contents.
1405 /// The `consume` function must be called with the number of bytes that are
1406 /// consumed from this buffer returned to ensure that the bytes are never
1411 /// This function will return an I/O error if the underlying reader was
1412 /// read, but returned an error. Note that it is not an error to return a
1413 /// 0-length buffer.
1414 fn fill_buf<'a>(&'a mut self) -> IoResult<&'a [u8]>;
1416 /// Tells this buffer that `amt` bytes have been consumed from the buffer,
1417 /// so they should no longer be returned in calls to `read`.
1418 fn consume(&mut self, amt: uint);
1420 /// Reads the next line of input, interpreted as a sequence of UTF-8
1421 /// encoded Unicode codepoints. If a newline is encountered, then the
1422 /// newline is contained in the returned string.
1429 /// let mut reader = io::stdin();
1430 /// let input = reader.read_line().ok().unwrap_or("nothing".to_string());
1435 /// This function has the same error semantics as `read_until`:
1437 /// * All non-EOF errors will be returned immediately
1438 /// * If an error is returned previously consumed bytes are lost
1439 /// * EOF is only returned if no bytes have been read
1440 /// * Reach EOF may mean that the delimiter is not present in the return
1443 /// Additionally, this function can fail if the line of input read is not a
1444 /// valid UTF-8 sequence of bytes.
1445 fn read_line(&mut self) -> IoResult<String> {
1446 self.read_until(b'\n').and_then(|line|
1447 match String::from_utf8(line) {
1449 Err(_) => Err(standard_error(InvalidInput)),
1454 /// Create an iterator that reads a line on each iteration until EOF.
1458 /// Any error other than `EndOfFile` that is produced by the underlying Reader
1459 /// is returned by the iterator and should be handled by the caller.
1460 fn lines<'r>(&'r mut self) -> Lines<'r, Self> {
1461 Lines { buffer: self }
1464 /// Reads a sequence of bytes leading up to a specified delimiter. Once the
1465 /// specified byte is encountered, reading ceases and the bytes up to and
1466 /// including the delimiter are returned.
1470 /// If any I/O error is encountered other than EOF, the error is immediately
1471 /// returned. Note that this may discard bytes which have already been read,
1472 /// and those bytes will *not* be returned. It is recommended to use other
1473 /// methods if this case is worrying.
1475 /// If EOF is encountered, then this function will return EOF if 0 bytes
1476 /// have been read, otherwise the pending byte buffer is returned. This
1477 /// is the reason that the byte buffer returned may not always contain the
1479 fn read_until(&mut self, byte: u8) -> IoResult<Vec<u8>> {
1480 let mut res = Vec::new();
1485 let available = match self.fill_buf() {
1487 Err(ref e) if res.len() > 0 && e.kind == EndOfFile => {
1491 Err(e) => return Err(e)
1493 match available.iter().position(|&b| b == byte) {
1495 res.push_all(available.slice_to(i + 1));
1500 res.push_all(available);
1501 used = available.len();
1511 /// Reads the next utf8-encoded character from the underlying stream.
1515 /// If an I/O error occurs, or EOF, then this function will return `Err`.
1516 /// This function will also return error if the stream does not contain a
1517 /// valid utf-8 encoded codepoint as the next few bytes in the stream.
1518 fn read_char(&mut self) -> IoResult<char> {
1519 let first_byte = try!(self.read_byte());
1520 let width = str::utf8_char_width(first_byte);
1521 if width == 1 { return Ok(first_byte as char) }
1522 if width == 0 { return Err(standard_error(InvalidInput)) } // not utf8
1523 let mut buf = [first_byte, 0, 0, 0];
1526 while start < width {
1527 match try!(self.read(buf.mut_slice(start, width))) {
1528 n if n == width - start => break,
1529 n if n < width - start => { start += n; }
1530 _ => return Err(standard_error(InvalidInput)),
1534 match str::from_utf8(buf.slice_to(width)) {
1535 Some(s) => Ok(s.char_at(0)),
1536 None => Err(standard_error(InvalidInput))
1540 /// Create an iterator that reads a utf8-encoded character on each iteration
1545 /// Any error other than `EndOfFile` that is produced by the underlying Reader
1546 /// is returned by the iterator and should be handled by the caller.
1547 fn chars<'r>(&'r mut self) -> Chars<'r, Self> {
1548 Chars { buffer: self }
1552 /// When seeking, the resulting cursor is offset from a base by the offset given
1553 /// to the `seek` function. The base used is specified by this enumeration.
1554 pub enum SeekStyle {
1555 /// Seek from the beginning of the stream
1557 /// Seek from the end of the stream
1559 /// Seek from the current position
1563 /// An object implementing `Seek` internally has some form of cursor which can
1564 /// be moved within a stream of bytes. The stream typically has a fixed size,
1565 /// allowing seeking relative to either end.
1567 /// Return position of file cursor in the stream
1568 fn tell(&self) -> IoResult<u64>;
1570 /// Seek to an offset in a stream
1572 /// A successful seek clears the EOF indicator. Seeking beyond EOF is
1573 /// allowed, but seeking before position 0 is not allowed.
1577 /// * Seeking to a negative offset is considered an error
1578 /// * Seeking past the end of the stream does not modify the underlying
1579 /// stream, but the next write may cause the previous data to be filled in
1580 /// with a bit pattern.
1581 fn seek(&mut self, pos: i64, style: SeekStyle) -> IoResult<()>;
1584 /// A listener is a value that can consume itself to start listening for
1587 /// Doing so produces some sort of Acceptor.
1588 pub trait Listener<T, A: Acceptor<T>> {
1589 /// Spin up the listener and start queuing incoming connections
1593 /// Returns `Err` if this listener could not be bound to listen for
1594 /// connections. In all cases, this listener is consumed.
1595 fn listen(self) -> IoResult<A>;
1598 /// An acceptor is a value that presents incoming connections
1599 pub trait Acceptor<T> {
1600 /// Wait for and accept an incoming connection
1604 /// Returns `Err` if an I/O error is encountered.
1605 fn accept(&mut self) -> IoResult<T>;
1607 /// Create an iterator over incoming connection attempts.
1609 /// Note that I/O errors will be yielded by the iterator itself.
1610 fn incoming<'r>(&'r mut self) -> IncomingConnections<'r, Self> {
1611 IncomingConnections { inc: self }
1615 /// An infinite iterator over incoming connection attempts.
1616 /// Calling `next` will block the task until a connection is attempted.
1618 /// Since connection attempts can continue forever, this iterator always returns
1619 /// `Some`. The `Some` contains the `IoResult` representing whether the
1620 /// connection attempt was successful. A successful connection will be wrapped
1621 /// in `Ok`. A failed connection is represented as an `Err`.
1622 pub struct IncomingConnections<'a, A:'a> {
1626 impl<'a, T, A: Acceptor<T>> Iterator<IoResult<T>> for IncomingConnections<'a, A> {
1627 fn next(&mut self) -> Option<IoResult<T>> {
1628 Some(self.inc.accept())
1632 /// Creates a standard error for a commonly used flavor of error. The `detail`
1633 /// field of the returned error will always be `None`.
1640 /// let eof = io::standard_error(io::EndOfFile);
1641 /// let einval = io::standard_error(io::InvalidInput);
1643 pub fn standard_error(kind: IoErrorKind) -> IoError {
1644 let desc = match kind {
1645 EndOfFile => "end of file",
1646 IoUnavailable => "I/O is unavailable",
1647 InvalidInput => "invalid input",
1648 OtherIoError => "unknown I/O error",
1649 FileNotFound => "file not found",
1650 PermissionDenied => "permission denied",
1651 ConnectionFailed => "connection failed",
1652 Closed => "stream is closed",
1653 ConnectionRefused => "connection refused",
1654 ConnectionReset => "connection reset",
1655 ConnectionAborted => "connection aborted",
1656 NotConnected => "not connected",
1657 BrokenPipe => "broken pipe",
1658 PathAlreadyExists => "file already exists",
1659 PathDoesntExist => "no such file",
1660 MismatchedFileTypeForOperation => "mismatched file type",
1661 ResourceUnavailable => "resource unavailable",
1662 TimedOut => "operation timed out",
1663 ShortWrite(..) => "short write",
1664 NoProgress => "no progress",
1673 /// A mode specifies how a file should be opened or created. These modes are
1674 /// passed to `File::open_mode` and are used to control where the file is
1675 /// positioned when it is initially opened.
1677 /// Opens a file positioned at the beginning.
1679 /// Opens a file positioned at EOF.
1681 /// Opens a file, truncating it if it already exists.
1685 /// Access permissions with which the file should be opened. `File`s
1686 /// opened with `Read` will return an error if written to.
1687 pub enum FileAccess {
1688 /// Read-only access, requests to write will result in an error
1690 /// Write-only access, requests to read will result in an error
1692 /// Read-write access, no requests are denied by default
1696 /// Different kinds of files which can be identified by a call to stat
1697 #[deriving(PartialEq, Show, Hash)]
1699 /// This is a normal file, corresponding to `S_IFREG`
1702 /// This file is a directory, corresponding to `S_IFDIR`
1705 /// This file is a named pipe, corresponding to `S_IFIFO`
1708 /// This file is a block device, corresponding to `S_IFBLK`
1711 /// This file is a symbolic link to another file, corresponding to `S_IFLNK`
1714 /// The type of this file is not recognized as one of the other categories
1718 /// A structure used to describe metadata information about a file. This
1719 /// structure is created through the `stat` method on a `Path`.
1726 /// let info = match Path::new("foo.txt").stat() {
1727 /// Ok(stat) => stat,
1728 /// Err(e) => fail!("couldn't read foo.txt: {}", e),
1731 /// println!("byte size: {}", info.size);
1735 pub struct FileStat {
1736 /// The size of the file, in bytes
1738 /// The kind of file this path points to (directory, file, pipe, etc.)
1740 /// The file permissions currently on the file
1741 pub perm: FilePermission,
1743 // FIXME(#10301): These time fields are pretty useless without an actual
1744 // time representation, what are the milliseconds relative
1747 /// The time that the file was created at, in platform-dependent
1750 /// The time that this file was last modified, in platform-dependent
1753 /// The time that this file was last accessed, in platform-dependent
1757 /// Information returned by stat() which is not guaranteed to be
1758 /// platform-independent. This information may be useful on some platforms,
1759 /// but it may have different meanings or no meaning at all on other
1762 /// Usage of this field is discouraged, but if access is desired then the
1763 /// fields are located here.
1765 pub unstable: UnstableFileStat,
1768 /// This structure represents all of the possible information which can be
1769 /// returned from a `stat` syscall which is not contained in the `FileStat`
1770 /// structure. This information is not necessarily platform independent, and may
1771 /// have different meanings or no meaning at all on some platforms.
1774 pub struct UnstableFileStat {
1775 /// The ID of the device containing the file.
1777 /// The file serial number.
1781 /// The number of hard links to this file.
1783 /// The user ID of the file.
1785 /// The group ID of the file.
1787 /// The optimal block size for I/O.
1789 /// The blocks allocated for this file.
1791 /// User-defined flags for the file.
1793 /// The file generation number.
1798 #[doc = "A set of permissions for a file or directory is represented"]
1799 #[doc = "by a set of flags which are or'd together."]
1800 flags FilePermission: u32 {
1801 static UserRead = 0o400,
1802 static UserWrite = 0o200,
1803 static UserExecute = 0o100,
1804 static GroupRead = 0o040,
1805 static GroupWrite = 0o020,
1806 static GroupExecute = 0o010,
1807 static OtherRead = 0o004,
1808 static OtherWrite = 0o002,
1809 static OtherExecute = 0o001,
1811 static UserRWX = UserRead.bits | UserWrite.bits | UserExecute.bits,
1812 static GroupRWX = GroupRead.bits | GroupWrite.bits | GroupExecute.bits,
1813 static OtherRWX = OtherRead.bits | OtherWrite.bits | OtherExecute.bits,
1815 #[doc = "Permissions for user owned files, equivalent to 0644 on"]
1816 #[doc = "unix-like systems."]
1817 static UserFile = UserRead.bits | UserWrite.bits | GroupRead.bits | OtherRead.bits,
1819 #[doc = "Permissions for user owned directories, equivalent to 0755 on"]
1820 #[doc = "unix-like systems."]
1821 static UserDir = UserRWX.bits | GroupRead.bits | GroupExecute.bits |
1822 OtherRead.bits | OtherExecute.bits,
1824 #[doc = "Permissions for user owned executables, equivalent to 0755"]
1825 #[doc = "on unix-like systems."]
1826 static UserExec = UserDir.bits,
1828 #[doc = "All possible permissions enabled."]
1829 static AllPermissions = UserRWX.bits | GroupRWX.bits | OtherRWX.bits,
1833 impl Default for FilePermission {
1835 fn default() -> FilePermission { FilePermission::empty() }
1838 impl fmt::Show for FilePermission {
1839 fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
1840 formatter.fill = '0';
1841 formatter.width = Some(4);
1842 (&self.bits as &fmt::Octal).fmt(formatter)
1848 use super::{IoResult, Reader, MemReader, NoProgress, InvalidInput};
1852 #[deriving(Clone, PartialEq, Show)]
1853 enum BadReaderBehavior {
1858 struct BadReader<T> {
1860 behavior: Vec<BadReaderBehavior>,
1863 impl<T: Reader> BadReader<T> {
1864 fn new(r: T, behavior: Vec<BadReaderBehavior>) -> BadReader<T> {
1865 BadReader { behavior: behavior, r: r }
1869 impl<T: Reader> Reader for BadReader<T> {
1870 fn read(&mut self, buf: &mut [u8]) -> IoResult<uint> {
1871 let BadReader { ref mut behavior, ref mut r } = *self;
1873 if behavior.is_empty() {
1874 // fall back on good
1877 match behavior.as_mut_slice()[0] {
1878 GoodBehavior(0) => (),
1879 GoodBehavior(ref mut x) => {
1883 BadBehavior(0) => (),
1884 BadBehavior(ref mut x) => {
1895 fn test_read_at_least() {
1896 let mut r = BadReader::new(MemReader::new(Vec::from_slice(b"hello, world!")),
1897 Vec::from_slice([GoodBehavior(uint::MAX)]));
1898 let mut buf = [0u8, ..5];
1899 assert!(r.read_at_least(1, buf).unwrap() >= 1);
1900 assert!(r.read_exact(5).unwrap().len() == 5); // read_exact uses read_at_least
1901 assert!(r.read_at_least(0, buf).is_ok());
1903 let mut r = BadReader::new(MemReader::new(Vec::from_slice(b"hello, world!")),
1904 Vec::from_slice([BadBehavior(50), GoodBehavior(uint::MAX)]));
1905 assert!(r.read_at_least(1, buf).unwrap() >= 1);
1907 let mut r = BadReader::new(MemReader::new(Vec::from_slice(b"hello, world!")),
1908 Vec::from_slice([BadBehavior(1), GoodBehavior(1),
1909 BadBehavior(50), GoodBehavior(uint::MAX)]));
1910 assert!(r.read_at_least(1, buf).unwrap() >= 1);
1911 assert!(r.read_at_least(1, buf).unwrap() >= 1);
1913 let mut r = BadReader::new(MemReader::new(Vec::from_slice(b"hello, world!")),
1914 Vec::from_slice([BadBehavior(uint::MAX)]));
1915 assert_eq!(r.read_at_least(1, buf).unwrap_err().kind, NoProgress);
1917 let mut r = MemReader::new(Vec::from_slice(b"hello, world!"));
1918 assert_eq!(r.read_at_least(5, buf).unwrap(), 5);
1919 assert_eq!(r.read_at_least(6, buf).unwrap_err().kind, InvalidInput);
1923 fn test_push_at_least() {
1924 let mut r = BadReader::new(MemReader::new(Vec::from_slice(b"hello, world!")),
1925 Vec::from_slice([GoodBehavior(uint::MAX)]));
1926 let mut buf = Vec::new();
1927 assert!(r.push_at_least(1, 5, &mut buf).unwrap() >= 1);
1928 assert!(r.push_at_least(0, 5, &mut buf).is_ok());
1930 let mut r = BadReader::new(MemReader::new(Vec::from_slice(b"hello, world!")),
1931 Vec::from_slice([BadBehavior(50), GoodBehavior(uint::MAX)]));
1932 assert!(r.push_at_least(1, 5, &mut buf).unwrap() >= 1);
1934 let mut r = BadReader::new(MemReader::new(Vec::from_slice(b"hello, world!")),
1935 Vec::from_slice([BadBehavior(1), GoodBehavior(1),
1936 BadBehavior(50), GoodBehavior(uint::MAX)]));
1937 assert!(r.push_at_least(1, 5, &mut buf).unwrap() >= 1);
1938 assert!(r.push_at_least(1, 5, &mut buf).unwrap() >= 1);
1940 let mut r = BadReader::new(MemReader::new(Vec::from_slice(b"hello, world!")),
1941 Vec::from_slice([BadBehavior(uint::MAX)]));
1942 assert_eq!(r.push_at_least(1, 5, &mut buf).unwrap_err().kind, NoProgress);
1944 let mut r = MemReader::new(Vec::from_slice(b"hello, world!"));
1945 assert_eq!(r.push_at_least(5, 1, &mut buf).unwrap_err().kind, InvalidInput);
1952 assert_eq!(format!("{}", UserRead), "0400".to_string());
1953 assert_eq!(format!("{}", UserFile), "0644".to_string());
1954 assert_eq!(format!("{}", UserExec), "0755".to_string());
1955 assert_eq!(format!("{}", UserRWX), "0700".to_string());
1956 assert_eq!(format!("{}", GroupRWX), "0070".to_string());
1957 assert_eq!(format!("{}", OtherRWX), "0007".to_string());
1958 assert_eq!(format!("{}", AllPermissions), "0777".to_string());
1959 assert_eq!(format!("{}", UserRead | UserWrite | OtherWrite), "0602".to_string());