# Struct std::os::unix::net::UnixStream

1.10.0 · source ·

    pub struct UnixStream(/* private fields */);

Available on Unix only.
Expand description

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§

source§

### impl UnixStream

source

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

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
1.70.0 · source

#### pub fn connect_addr(socket_addr: &SocketAddr) -> Result<UnixStream>

Connects to the socket specified by `address`.

##### Examples

    use std::os::unix::net::{UnixListener, UnixStream};

    fn main() -> std::io::Result<()> {
        let listener = UnixListener::bind("/path/to/the/socket")?;
        let addr = listener.local_addr()?;

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

Run
source

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

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
source

#### pub 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 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
source

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

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
source

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

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
source

#### pub fn peer_cred(&self) -> Result<UCred>

🔬This is a nightly-only experimental API. (`peer_credentials_unix_socket` #42839)

Gets the peer credentials for this Unix domain socket.

##### Examples

    #![feature(peer_credentials_unix_socket)]
    use std::os::unix::net::UnixStream;

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

Run
source

#### pub 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. 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
source

#### pub 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. 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
source

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

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
source

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

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
source

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

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
source

#### pub fn set_passcred(&self, passcred: bool) -> Result<()>

🔬This is a nightly-only experimental API. (`unix_socket_ancillary_data` #76915)

Moves the socket to pass unix credentials as control message in `SocketAncillary`.

Set the socket option `SO_PASSCRED`.

##### Examples

    #![feature(unix_socket_ancillary_data)]
    use std::os::unix::net::UnixStream;

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

Run
source

#### pub fn passcred(&self) -> Result<bool>

🔬This is a nightly-only experimental API. (`unix_socket_ancillary_data` #76915)

Get the current value of the socket for passing unix credentials in `SocketAncillary`. This value can be change by `set_passcred`.

Get the socket option `SO_PASSCRED`.

source

#### pub fn set_mark(&self, mark: u32) -> Result<()>

🔬This is a nightly-only experimental API. (`unix_set_mark` #96467)

Set the id of the socket for network filtering purpose

    #![feature(unix_set_mark)]
    use std::os::unix::net::UnixStream;

    fn main() -> std::io::Result<()> {
        let sock = UnixStream::connect("/tmp/sock")?;
        sock.set_mark(32)?;
        Ok(())
    }

Run
source

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

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

source

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

##### 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
source

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

🔬This is a nightly-only experimental API. (`unix_socket_peek` #76923)

Receives data on the socket from the remote address to which it is connected, without removing that data from the queue. On success, returns the number of bytes peeked.

Successive calls return the same data. This is accomplished by passing `MSG_PEEK` as a flag to the underlying `recv` system call.

##### Examples

    #![feature(unix_socket_peek)]

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

    fn main() -> std::io::Result<()> {
        let socket = UnixStream::connect("/tmp/sock")?;
        let mut buf = [0; 10];
        let len = socket.peek(&mut buf).expect("peek failed");
        Ok(())
    }

Run
source

#### pub fn recv_vectored_with_ancillary( &self, bufs: &mut [IoSliceMut<'_>], ancillary: &mut SocketAncillary<'_> ) -> Result<usize>

🔬This is a nightly-only experimental API. (`unix_socket_ancillary_data` #76915)

Receives data and ancillary data from socket.

On success, returns the number of bytes read.

##### Examples

    #![feature(unix_socket_ancillary_data)]
    use std::os::unix::net::{UnixStream, SocketAncillary, AncillaryData};
    use std::io::IoSliceMut;

    fn main() -> std::io::Result<()> {
        let socket = UnixStream::connect("/tmp/sock")?;
        let mut buf1 = [1; 8];
        let mut buf2 = [2; 16];
        let mut buf3 = [3; 8];
        let mut bufs = &mut [
            IoSliceMut::new(&mut buf1),
            IoSliceMut::new(&mut buf2),
            IoSliceMut::new(&mut buf3),
        ][..];
        let mut fds = [0; 8];
        let mut ancillary_buffer = [0; 128];
        let mut ancillary = SocketAncillary::new(&mut ancillary_buffer[..]);
        let size = socket.recv_vectored_with_ancillary(bufs, &mut ancillary)?;
        println!("received {size}");
        for ancillary_result in ancillary.messages() {
            if let AncillaryData::ScmRights(scm_rights) = ancillary_result.unwrap() {
                for fd in scm_rights {
                    println!("receive file descriptor: {fd}");
                }
            }
        }
        Ok(())
    }

Run
source

#### pub fn send_vectored_with_ancillary( &self, bufs: &[IoSlice<'_>], ancillary: &mut SocketAncillary<'_> ) -> Result<usize>

🔬This is a nightly-only experimental API. (`unix_socket_ancillary_data` #76915)

Sends data and ancillary data on the socket.

On success, returns the number of bytes written.

##### Examples

    #![feature(unix_socket_ancillary_data)]
    use std::os::unix::net::{UnixStream, SocketAncillary};
    use std::io::IoSlice;

    fn main() -> std::io::Result<()> {
        let socket = UnixStream::connect("/tmp/sock")?;
        let buf1 = [1; 8];
        let buf2 = [2; 16];
        let buf3 = [3; 8];
        let bufs = &[
            IoSlice::new(&buf1),
            IoSlice::new(&buf2),
            IoSlice::new(&buf3),
        ][..];
        let fds = [0, 1, 2];
        let mut ancillary_buffer = [0; 128];
        let mut ancillary = SocketAncillary::new(&mut ancillary_buffer[..]);
        ancillary.add_fds(&fds[..]);
        socket.send_vectored_with_ancillary(bufs, &mut ancillary)
            .expect("send_vectored_with_ancillary function failed");
        Ok(())
    }

Run

## Trait Implementations§

1.63.0 · source§

### impl AsFd for UnixStream

source§

#### fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor. Read more
source§

### impl AsRawFd for UnixStream

source§

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

Extracts the raw file descriptor. Read more
source§

### impl Debug for UnixStream

source§

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

Formats the value using the given formatter. Read more
1.63.0 · source§

### impl From<OwnedFd> for UnixStream

source§

#### fn from(owned: OwnedFd) -> Self

Converts to this type from the input type.
1.63.0 · source§

### impl From<UnixStream> for OwnedFd

source§

#### fn from(unix_stream: UnixStream) -> OwnedFd

Converts to this type from the input type.
source§

### impl FromRawFd for UnixStream

source§

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

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

### impl IntoRawFd for UnixStream

source§

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

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

### impl<'a> Read for &'a UnixStream

source§

#### 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
source§

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

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

#### fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (`can_vector` #69941)
Determines if this `Read`er has an efficient `read_vectored` implementation. Read more
1.0.0 · source§

#### 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
1.0.0 · source§

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

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

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

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

#### fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<()>

🔬This is a nightly-only experimental API. (`read_buf` #78485)
Pull some bytes from this source into the specified buffer. Read more
source§

#### fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<()>

🔬This is a nightly-only experimental API. (`read_buf` #78485)
Read the exact number of bytes required to fill `cursor`. Read more
1.0.0 · source§

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

Creates a “by reference” adaptor for this instance of `Read`. Read more
1.0.0 · source§

#### fn bytes(self) -> Bytes<Self> ⓘwhere Self: Sized,

Transforms this `Read` instance to an `Iterator` over its bytes. Read more
1.0.0 · source§

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

Creates an adapter which will chain this stream with another. Read more
1.0.0 · source§

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

Creates an adapter which will read at most `limit` bytes from it. Read more
source§

### impl Read for UnixStream

source§

#### 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
source§

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

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

#### fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (`can_vector` #69941)
Determines if this `Read`er has an efficient `read_vectored` implementation. Read more
1.0.0 · source§

#### 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
1.0.0 · source§

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

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

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

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

#### fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<()>

🔬This is a nightly-only experimental API. (`read_buf` #78485)
Pull some bytes from this source into the specified buffer. Read more
source§

#### fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<()>

🔬This is a nightly-only experimental API. (`read_buf` #78485)
Read the exact number of bytes required to fill `cursor`. Read more
1.0.0 · source§

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

Creates a “by reference” adaptor for this instance of `Read`. Read more
1.0.0 · source§

#### fn bytes(self) -> Bytes<Self> ⓘwhere Self: Sized,

Transforms this `Read` instance to an `Iterator` over its bytes. Read more
1.0.0 · source§

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

Creates an adapter which will chain this stream with another. Read more
1.0.0 · source§

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

Creates an adapter which will read at most `limit` bytes from it. Read more
source§

### impl<'a> Write for &'a UnixStream

source§

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

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

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

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

#### fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (`can_vector` #69941)
Determines if this `Write`r has an efficient `write_vectored` implementation. Read more
source§

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

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

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

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

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

🔬This is a nightly-only experimental API. (`write_all_vectored` #70436)
Attempts to write multiple buffers into this writer. Read more
1.0.0 · source§

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

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · source§

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

Creates a “by reference” adapter for this instance of `Write`. Read more
source§

### impl Write for UnixStream

source§

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

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

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

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

#### fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (`can_vector` #69941)
Determines if this `Write`r has an efficient `write_vectored` implementation. Read more
source§

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

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

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

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

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

🔬This is a nightly-only experimental API. (`write_all_vectored` #70436)
Attempts to write multiple buffers into this writer. Read more
1.0.0 · source§

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

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · source§

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

Creates a “by reference” adapter 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§

source§

### impl<T> Any for Twhere T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

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

### impl<T> Borrow<T> for Twhere T: ?Sized,

source§

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

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

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

Mutably borrows from an owned value. Read more
source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T, U> Into<U> for Twhere U: From<T>,

source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source§

### impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

### impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.