5d836cdf86
In preparation for upcoming changes to the `Writer` trait (soon to be called `Write`) this commit renames the current `write` method to `write_all` to match the semantics of the upcoming `write_all` method. The `write` method will be repurposed to return a `usize` indicating how much data was written which differs from the current `write` semantics. In order to head off as much unintended breakage as possible, the method is being deprecated now in favor of a new name. [breaking-change]
139 lines
3.8 KiB
Rust
139 lines
3.8 KiB
Rust
// Copyright 2013 The Rust Project Developers. See the COPYRIGHT
|
|
// file at the top-level directory of this distribution and at
|
|
// http://rust-lang.org/COPYRIGHT.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
|
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
|
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
|
// option. This file may not be copied, modified, or distributed
|
|
// except according to those terms.
|
|
|
|
//! Synchronous, in-memory pipes.
|
|
//!
|
|
//! Currently these aren't particularly useful, there only exists bindings
|
|
//! enough so that pipes can be created to child processes.
|
|
|
|
#![allow(missing_docs)]
|
|
|
|
use prelude::v1::*;
|
|
|
|
use old_io::IoResult;
|
|
use libc;
|
|
use sync::Arc;
|
|
|
|
use sys_common;
|
|
use sys;
|
|
use sys::fs::FileDesc as FileDesc;
|
|
|
|
/// A synchronous, in-memory pipe.
|
|
pub struct PipeStream {
|
|
inner: Arc<FileDesc>
|
|
}
|
|
|
|
pub struct PipePair {
|
|
pub reader: PipeStream,
|
|
pub writer: PipeStream,
|
|
}
|
|
|
|
impl PipeStream {
|
|
/// Consumes a file descriptor to return a pipe stream that will have
|
|
/// synchronous, but non-blocking reads/writes. This is useful if the file
|
|
/// descriptor is acquired via means other than the standard methods.
|
|
///
|
|
/// This operation consumes ownership of the file descriptor and it will be
|
|
/// closed once the object is deallocated.
|
|
///
|
|
/// # Example
|
|
///
|
|
/// ```{rust,no_run}
|
|
/// # #![allow(unused_must_use)]
|
|
/// extern crate libc;
|
|
///
|
|
/// use std::old_io::pipe::PipeStream;
|
|
///
|
|
/// fn main() {
|
|
/// let mut pipe = PipeStream::open(libc::STDERR_FILENO);
|
|
/// pipe.write(b"Hello, stderr!");
|
|
/// }
|
|
/// ```
|
|
pub fn open(fd: libc::c_int) -> IoResult<PipeStream> {
|
|
Ok(PipeStream::from_filedesc(FileDesc::new(fd, true)))
|
|
}
|
|
|
|
// FIXME: expose this some other way
|
|
/// Wrap a FileDesc directly, taking ownership.
|
|
#[doc(hidden)]
|
|
pub fn from_filedesc(fd: FileDesc) -> PipeStream {
|
|
PipeStream { inner: Arc::new(fd) }
|
|
}
|
|
|
|
/// Creates a pair of in-memory OS pipes for a unidirectional communication
|
|
/// stream.
|
|
///
|
|
/// The structure returned contains a reader and writer I/O object. Data
|
|
/// written to the writer can be read from the reader.
|
|
///
|
|
/// # Errors
|
|
///
|
|
/// This function can fail to succeed if the underlying OS has run out of
|
|
/// available resources to allocate a new pipe.
|
|
pub fn pair() -> IoResult<PipePair> {
|
|
let (reader, writer) = try!(unsafe { sys::os::pipe() });
|
|
Ok(PipePair {
|
|
reader: PipeStream::from_filedesc(reader),
|
|
writer: PipeStream::from_filedesc(writer),
|
|
})
|
|
}
|
|
}
|
|
|
|
impl sys_common::AsInner<sys::fs::FileDesc> for PipeStream {
|
|
fn as_inner(&self) -> &sys::fs::FileDesc {
|
|
&*self.inner
|
|
}
|
|
}
|
|
|
|
impl Clone for PipeStream {
|
|
fn clone(&self) -> PipeStream {
|
|
PipeStream { inner: self.inner.clone() }
|
|
}
|
|
}
|
|
|
|
impl Reader for PipeStream {
|
|
fn read(&mut self, buf: &mut [u8]) -> IoResult<uint> {
|
|
self.inner.read(buf)
|
|
}
|
|
}
|
|
|
|
impl Writer for PipeStream {
|
|
fn write_all(&mut self, buf: &[u8]) -> IoResult<()> {
|
|
self.inner.write(buf)
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use prelude::v1::*;
|
|
|
|
use sync::mpsc::channel;
|
|
use thread::Thread;
|
|
|
|
#[test]
|
|
fn partial_read() {
|
|
use os;
|
|
use old_io::pipe::PipeStream;
|
|
|
|
let os::Pipe { reader, writer } = unsafe { os::pipe().unwrap() };
|
|
let out = PipeStream::open(writer);
|
|
let mut input = PipeStream::open(reader);
|
|
let (tx, rx) = channel();
|
|
let _t = Thread::spawn(move|| {
|
|
let mut out = out;
|
|
out.write(&[10]).unwrap();
|
|
rx.recv().unwrap(); // don't close the pipe until the other read has finished
|
|
});
|
|
|
|
let mut buf = [0; 10];
|
|
input.read(&mut buf).unwrap();
|
|
tx.send(()).unwrap();
|
|
}
|
|
}
|