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

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

    pub struct UnixStream(_);

This is supported on Unix only.

A Unix stream socket.

# Examples

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

    fn main() -> std::io::Result<()> {
        let mut stream = UnixStream::connect("/path/to/my/socket")?;
        stream.write_all(b"hello world")?;
        let mut response = String::new();
        stream.read_to_string(&mut response)?;
        println!("{}", response);
        Ok(())
    }

Run

## Implementations

### `impl UnixStream`[src]

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

This is supported on Unix only.

Connects to the socket named by `path`.

# Examples

    use std::os::unix::net::UnixStream;

    let socket = match UnixStream::connect("/tmp/sock") {
        Ok(sock) => sock,
        Err(e) => {
            println!("Couldn't connect: {:?}", e);
            return
        }
    };

Run

#### `pub fn pair() -> Result<(UnixStream, UnixStream)>`[src]

This is supported on Unix only.

Creates an unnamed pair of connected sockets.

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

# Examples

    use std::os::unix::net::UnixStream;

    let (sock1, sock2) = match UnixStream::pair() {
        Ok((sock1, sock2)) => (sock1, sock2),
        Err(e) => {
            println!("Couldn't create a pair of sockets: {:?}", e);
            return
        }
    };

Run

#### `pub fn try_clone(&self) -> Result<UnixStream>`[src]

This is supported on Unix only.

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 propagated to the other stream.

# Examples

    use std::os::unix::net::UnixStream;

    fn main() -> std::io::Result<()> {
        let socket = UnixStream::connect("/tmp/sock")?;
        let sock_copy = socket.try_clone().expect("Couldn't clone socket");
        Ok(())
    }

Run

#### `pub fn local_addr(&self) -> Result<SocketAddr>`[src]

This is supported on Unix only.

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

# Examples

    use std::os::unix::net::UnixStream;

    fn main() -> std::io::Result<()> {
        let socket = UnixStream::connect("/tmp/sock")?;
        let addr = socket.local_addr().expect("Couldn't get local address");
        Ok(())
    }

Run

#### `pub fn peer_addr(&self) -> Result<SocketAddr>`[src]

This is supported on Unix only.

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

# Examples

    use std::os::unix::net::UnixStream;

    fn main() -> std::io::Result<()> {
        let socket = UnixStream::connect("/tmp/sock")?;
        let addr = socket.peer_addr().expect("Couldn't get peer address");
        Ok(())
    }

Run

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

This is supported on Unix only.

Sets the read timeout for the socket.

If the provided value is `None`, then `read` calls will block indefinitely. An `Err` is returned if the zero `Duration` is passed to this method.

# Examples

    use std::os::unix::net::UnixStream;
    use std::time::Duration;

    fn main() -> std::io::Result<()> {
        let socket = UnixStream::connect("/tmp/sock")?;
        socket.set_read_timeout(Some(Duration::new(1, 0))).expect("Couldn't set read timeout");
        Ok(())
    }

Run

An `Err` is returned if the zero `Duration` is passed to this method:

    use std::io;
    use std::os::unix::net::UnixStream;
    use std::time::Duration;

    fn main() -> std::io::Result<()> {
        let socket = UnixStream::connect("/tmp/sock")?;
        let result = socket.set_read_timeout(Some(Duration::new(0, 0)));
        let err = result.unwrap_err();
        assert_eq!(err.kind(), io::ErrorKind::InvalidInput);
        Ok(())
    }

Run

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

This is supported on Unix only.

Sets the write timeout for the socket.

If the provided value is `None`, then `write` calls will block indefinitely. An `Err` is returned if the zero `Duration` is passed to this method.

# Examples

    use std::os::unix::net::UnixStream;
    use std::time::Duration;

    fn main() -> std::io::Result<()> {
        let socket = UnixStream::connect("/tmp/sock")?;
        socket.set_write_timeout(Some(Duration::new(1, 0)))
            .expect("Couldn't set write timeout");
        Ok(())
    }

Run

An `Err` is returned if the zero `Duration` is passed to this method:

    use std::io;
    use std::net::UdpSocket;
    use std::time::Duration;

    fn main() -> std::io::Result<()> {
        let socket = UdpSocket::bind("127.0.0.1:34254")?;
        let result = socket.set_write_timeout(Some(Duration::new(0, 0)));
        let err = result.unwrap_err();
        assert_eq!(err.kind(), io::ErrorKind::InvalidInput);
        Ok(())
    }

Run

#### `pub fn read_timeout(&self) -> Result<Option<Duration>>`[src]

This is supported on Unix only.

Returns the read timeout of this socket.

# Examples

    use std::os::unix::net::UnixStream;
    use std::time::Duration;

    fn main() -> std::io::Result<()> {
        let socket = UnixStream::connect("/tmp/sock")?;
        socket.set_read_timeout(Some(Duration::new(1, 0))).expect("Couldn't set read timeout");
        assert_eq!(socket.read_timeout()?, Some(Duration::new(1, 0)));
        Ok(())
    }

Run

#### `pub fn write_timeout(&self) -> Result<Option<Duration>>`[src]

This is supported on Unix only.

Returns the write timeout of this socket.

# Examples

    use std::os::unix::net::UnixStream;
    use std::time::Duration;

    fn main() -> std::io::Result<()> {
        let socket = UnixStream::connect("/tmp/sock")?;
        socket.set_write_timeout(Some(Duration::new(1, 0)))
            .expect("Couldn't set write timeout");
        assert_eq!(socket.write_timeout()?, Some(Duration::new(1, 0)));
        Ok(())
    }

Run

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

This is supported on Unix only.

Moves the socket into or out of nonblocking mode.

# Examples

    use std::os::unix::net::UnixStream;

    fn main() -> std::io::Result<()> {
        let socket = UnixStream::connect("/tmp/sock")?;
        socket.set_nonblocking(true).expect("Couldn't set nonblocking");
        Ok(())
    }

Run

#### `pub fn take_error(&self) -> Result<Option<Error>>`[src]

This is supported on Unix only.

Returns the value of the `SO_ERROR` option.

# Examples

    use std::os::unix::net::UnixStream;

    fn main() -> std::io::Result<()> {
        let socket = UnixStream::connect("/tmp/sock")?;
        if let Ok(Some(err)) = socket.take_error() {
            println!("Got error: {:?}", err);
        }
        Ok(())
    }

Run

# Platform specific

On Redox this always returns `None`.

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

This is supported on Unix only.

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`).

# Examples

    use std::os::unix::net::UnixStream;
    use std::net::Shutdown;

    fn main() -> std::io::Result<()> {
        let socket = UnixStream::connect("/tmp/sock")?;
        socket.shutdown(Shutdown::Both).expect("shutdown function failed");
        Ok(())
    }

Run

## Trait Implementations

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

#### `fn as_raw_fd(&self) -> RawFd`[src]

This is supported on Unix only.

Extracts the raw file descriptor. Read more

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

#### `fn fmt(&self, fmt: &mut Formatter<'_>) -> Result`[src]

Formats the value using the given formatter. Read more

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

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

### Notable traits for UnixStream

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

This is supported on Unix only.

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`[src]

This is supported on Unix only.

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

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

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

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

#### `fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize>`[src]

Like `read`, except that it reads into a slice of buffers. Read more

#### `fn is_read_vectored(&self) -> bool`[src]

🔬 This is a nightly-only experimental API. (`can_vector` #69941)

Determines if this `Read`er has an efficient `read_vectored` implementation. Read more

#### `unsafe fn initializer(&self) -> Initializer`[src]

🔬 This is a nightly-only experimental API. (`read_initializer` #42788)

Determines if this `Read`er can work with buffers of uninitialized memory. Read more

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

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[src]

Read all bytes until EOF in this source, appending them to `buf`. Read more

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

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

#### `fn by_ref(&mut self) -> &mut Selfⓘ

### Notable traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<R: Read + ?Sized, '_> Read for &'_ mut Rimpl<W: Write + ?Sized, '_> Write for &'_ mut W`
where
Self: Sized,` 1.0.0[src]

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

#### `fn bytes(self) -> Bytes<Self>ⓘ

### Notable traits for Bytes<R>

`impl<R: Read> Iterator for Bytes<R> type Item = Result<u8>;`
where
Self: Sized,` 1.0.0[src]

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

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

### Notable traits for Chain<T, U>

`impl<T: Read, U: Read> Read for Chain<T, U>`
where
Self: Sized,` 1.0.0[src]

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

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

### Notable traits for Take<T>

`impl<T: Read> Read for Take<T>`
where
Self: Sized,` 1.0.0[src]

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>`[src]

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

#### `fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize>`[src]

Like `read`, except that it reads into a slice of buffers. Read more

#### `fn is_read_vectored(&self) -> bool`[src]

🔬 This is a nightly-only experimental API. (`can_vector` #69941)

Determines if this `Read`er has an efficient `read_vectored` implementation. Read more

#### `unsafe fn initializer(&self) -> Initializer`[src]

🔬 This is a nightly-only experimental API. (`read_initializer` #42788)

Determines if this `Read`er can work with buffers of uninitialized memory. Read more

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

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[src]

Read all bytes until EOF in this source, appending them to `buf`. Read more

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

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

#### `fn by_ref(&mut self) -> &mut Selfⓘ

### Notable traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<R: Read + ?Sized, '_> Read for &'_ mut Rimpl<W: Write + ?Sized, '_> Write for &'_ mut W`
where
Self: Sized,` 1.0.0[src]

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

#### `fn bytes(self) -> Bytes<Self>ⓘ

### Notable traits for Bytes<R>

`impl<R: Read> Iterator for Bytes<R> type Item = Result<u8>;`
where
Self: Sized,` 1.0.0[src]

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

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

### Notable traits for Chain<T, U>

`impl<T: Read, U: Read> Read for Chain<T, U>`
where
Self: Sized,` 1.0.0[src]

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

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

### Notable traits for Take<T>

`impl<T: Read> Read for Take<T>`
where
Self: Sized,` 1.0.0[src]

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>`[src]

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

#### `fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>`[src]

Like [`write`], except that it writes from a slice of buffers. Read more

#### `fn is_write_vectored(&self) -> bool`[src]

🔬 This is a nightly-only experimental API. (`can_vector` #69941)

Determines if this `Write`er has an efficient [`write_vectored`] implementation. Read more

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

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[src]

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

#### `fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<()>`[src]

🔬 This is a nightly-only experimental API. (`write_all_vectored` #70436)

Attempts to write multiple buffers into this writer. Read more

#### `fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<()>`1.0.0[src]

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

#### `fn by_ref(&mut self) -> &mut Selfⓘ

### Notable traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<R: Read + ?Sized, '_> Read for &'_ mut Rimpl<W: Write + ?Sized, '_> Write for &'_ mut W`
where
Self: Sized,` 1.0.0[src]

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>`[src]

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

#### `fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>`[src]

Like [`write`], except that it writes from a slice of buffers. Read more

#### `fn is_write_vectored(&self) -> bool`[src]

🔬 This is a nightly-only experimental API. (`can_vector` #69941)

Determines if this `Write`er has an efficient [`write_vectored`] implementation. Read more

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

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[src]

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

#### `fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<()>`[src]

🔬 This is a nightly-only experimental API. (`write_all_vectored` #70436)

Attempts to write multiple buffers into this writer. Read more

#### `fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<()>`1.0.0[src]

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

#### `fn by_ref(&mut self) -> &mut Selfⓘ

### Notable traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<R: Read + ?Sized, '_> Read for &'_ mut Rimpl<W: Write + ?Sized, '_> Write for &'_ mut W`
where
Self: Sized,` 1.0.0[src]

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

## Auto Trait Implementations

### `impl RefUnwindSafe for UnixStream`

### `impl Send for UnixStream`

### `impl Sync for UnixStream`

### `impl Unpin for UnixStream`

### `impl UnwindSafe for UnixStream`

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `fn borrow(&self) -> &Tⓘ

### Notable traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<R: Read + ?Sized, '_> Read for &'_ mut Rimpl<W: Write + ?Sized, '_> Write for &'_ mut W`
`[src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `fn borrow_mut(&mut self) -> &mut Tⓘ

### Notable traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<R: Read + ?Sized, '_> Read for &'_ mut Rimpl<W: Write + ?Sized, '_> Write for &'_ mut W`
`[src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T`[src]

#### `fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(self) -> U`[src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.