std::os::unix::net::UnixStream - Rust
Description: API documentation for the Rust `UnixStream` struct in crate `std`.
Keywords: rust, rustlang, rust-lang, UnixStream

# Struct std::os::unix::net::UnixStream 1.10.0 [−] [src]

    pub struct UnixStream(_);

A Unix stream socket.

# Examples

    use std::os::unix::net::UnixStream;
    use std::io::prelude::*;

    let mut stream = UnixStream::connect("/path/to/my/socket").unwrap();
    stream.write_all(b"hello world").unwrap();
    let mut response = String::new();
    stream.read_to_string(&mut response).unwrap();
    println!("{}", response);Run

## Methods

### `impl UnixStream`
[src]

#### `fn connect<P: AsRef<Path>>(path: P) -> Result<UnixStream>`

Connects to the socket named by `path`.

#### `fn pair() -> Result<(UnixStream, UnixStream)>`

Creates an unnamed pair of connected sockets.

Returns two `UnixStream`s which are connected to each other.

#### `fn try_clone(&self) -> Result<UnixStream>`

Creates a new independently owned handle to the underlying socket.

The returned `UnixStream` is a reference to the same stream that this object references. Both handles will read and write the same stream of data, and options set on one stream will be propogated to the other stream.

#### `fn local_addr(&self) -> Result<SocketAddr>`

Returns the socket address of the local half of this connection.

#### `fn peer_addr(&self) -> Result<SocketAddr>`

Returns the socket address of the remote half of this connection.

#### `fn set_read_timeout(&self, timeout: Option<Duration>) -> Result<()>`

Sets the read timeout for the socket.

If the provided value is `None`, then `read` calls will block indefinitely. It is an error to pass the zero `Duration` to this method.

#### `fn set_write_timeout(&self, timeout: Option<Duration>) -> Result<()>`

Sets the write timeout for the socket.

If the provided value is `None`, then `write` calls will block indefinitely. It is an error to pass the zero `Duration` to this method.

#### `fn read_timeout(&self) -> Result<Option<Duration>>`

Returns the read timeout of this socket.

#### `fn write_timeout(&self) -> Result<Option<Duration>>`

Returns the write timeout of this socket.

#### `fn set_nonblocking(&self, nonblocking: bool) -> Result<()>`

Moves the socket into or out of nonblocking mode.

#### `fn take_error(&self) -> Result<Option<Error>>`

Returns the value of the `SO_ERROR` option.

#### `fn shutdown(&self, how: Shutdown) -> Result<()>`

Shuts down the read, write, or both halves of this connection.

This function will cause all pending and future I/O calls on the specified portions to immediately return with an appropriate value (see the documentation of `Shutdown`).

## Trait Implementations

### `impl Debug for UnixStream`
[src]

#### `fn fmt(&self, fmt: &mut Formatter) -> Result`

Formats the value using the given formatter.

### `impl Read for UnixStream`
[src]

#### `fn read(&mut self, buf: &mut [u8]) -> Result<usize>`

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more

#### `fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>`

Read all bytes until EOF in this source, placing them into `buf`. Read more

#### `fn read_to_string(&mut self, buf: &mut String) -> Result<usize>`
1.0.0

Read all bytes until EOF in this source, placing them into `buf`. Read more

#### `fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>`
1.6.0

Read the exact number of bytes required to fill `buf`. Read more

#### `fn by_ref(&mut self) -> &mut Self where Self: Sized`
1.0.0

Creates a "by reference" adaptor for this instance of `Read`. Read more

#### `fn bytes(self) -> Bytes<Self> where Self: Sized`
1.0.0

Transforms this `Read` instance to an `Iterator` over its bytes. Read more

#### `fn chars(self) -> Chars<Self> where Self: Sized`

Unstable (`io` #27802)

: the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this `Read` instance to an `Iterator` over `char`s. Read more

#### `fn chain<R: Read>(self, next: R) -> Chain<Self, R> where Self: Sized`
1.0.0

Creates an adaptor which will chain this stream with another. Read more

#### `fn take(self, limit: u64) -> Take<Self> where Self: Sized`
1.0.0

Creates an adaptor which will read at most `limit` bytes from it. Read more

### `impl<'a> Read for &'a UnixStream`
[src]

#### `fn read(&mut self, buf: &mut [u8]) -> Result<usize>`

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more

#### `fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>`

Read all bytes until EOF in this source, placing them into `buf`. Read more

#### `fn read_to_string(&mut self, buf: &mut String) -> Result<usize>`
1.0.0

Read all bytes until EOF in this source, placing them into `buf`. Read more

#### `fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>`
1.6.0

Read the exact number of bytes required to fill `buf`. Read more

#### `fn by_ref(&mut self) -> &mut Self where Self: Sized`
1.0.0

Creates a "by reference" adaptor for this instance of `Read`. Read more

#### `fn bytes(self) -> Bytes<Self> where Self: Sized`
1.0.0

Transforms this `Read` instance to an `Iterator` over its bytes. Read more

#### `fn chars(self) -> Chars<Self> where Self: Sized`

Unstable (`io` #27802)

: the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this `Read` instance to an `Iterator` over `char`s. Read more

#### `fn chain<R: Read>(self, next: R) -> Chain<Self, R> where Self: Sized`
1.0.0

Creates an adaptor which will chain this stream with another. Read more

#### `fn take(self, limit: u64) -> Take<Self> where Self: Sized`
1.0.0

Creates an adaptor which will read at most `limit` bytes from it. Read more

### `impl Write for UnixStream`
[src]

#### `fn write(&mut self, buf: &[u8]) -> Result<usize>`

Write a buffer into this object, returning how many bytes were written. Read more

#### `fn flush(&mut self) -> Result<()>`

Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more

#### `fn write_all(&mut self, buf: &[u8]) -> Result<()>`
1.0.0

Attempts to write an entire buffer into this write. Read more

#### `fn write_fmt(&mut self, fmt: Arguments) -> Result<()>`
1.0.0

Writes a formatted string into this writer, returning any error encountered. Read more

#### `fn by_ref(&mut self) -> &mut Self where Self: Sized`
1.0.0

Creates a "by reference" adaptor for this instance of `Write`. Read more

### `impl<'a> Write for &'a UnixStream`
[src]

#### `fn write(&mut self, buf: &[u8]) -> Result<usize>`

Write a buffer into this object, returning how many bytes were written. Read more

#### `fn flush(&mut self) -> Result<()>`

Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more

#### `fn write_all(&mut self, buf: &[u8]) -> Result<()>`
1.0.0

Attempts to write an entire buffer into this write. Read more

#### `fn write_fmt(&mut self, fmt: Arguments) -> Result<()>`
1.0.0

Writes a formatted string into this writer, returning any error encountered. Read more

#### `fn by_ref(&mut self) -> &mut Self where Self: Sized`
1.0.0

Creates a "by reference" adaptor for this instance of `Write`. Read more

### `impl AsRawFd for UnixStream`
[src]

#### `fn as_raw_fd(&self) -> RawFd`

Extracts the raw file descriptor. Read more

### `impl FromRawFd for UnixStream`
[src]

#### `unsafe fn from_raw_fd(fd: RawFd) -> UnixStream`

Constructs a new instance of `Self` from the given raw file descriptor. Read more

### `impl IntoRawFd for UnixStream`
[src]

#### `fn into_raw_fd(self) -> RawFd`

Consumes this object, returning the raw underlying file descriptor. Read more

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)