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

pub struct UnixStream(_);

Unstable (unix_socket #32312)

: newly added

A Unix stream socket.

Examples

#![feature(unix_socket)] fn main() { 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); }

#![feature(unix_socket)]

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);

Methods

impl UnixStream

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

Unstable (unix_socket #32312)

: newly added

Connects to the socket named by path.

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

Unstable (unix_socket #32312)

: newly added

Creates an unnamed pair of connected sockets.

Returns two UnixStreams which are connected to each other.

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

Unstable (unix_socket #32312)

: newly added

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>

Unstable (unix_socket #32312)

: newly added

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

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

Unstable (unix_socket #32312)

: newly added

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

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

Unstable (unix_socket #32312)

: newly added

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<()>

Unstable (unix_socket #32312)

: newly added

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

Unstable (unix_socket #32312)

: newly added

Returns the read timeout of this socket.

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

Unstable (unix_socket #32312)

: newly added

Returns the write timeout of this socket.

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

Unstable (unix_socket #32312)

: newly added

Moves the socket into or out of nonblocking mode.

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

Unstable (unix_socket #32312)

: newly added

Returns the value of the SO_ERROR option.

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

Unstable (unix_socket #32312)

: newly added

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

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

Formats the value using the given formatter.

impl Read for UnixStream

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.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

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

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

Transforms this Read instance to an Iterator over its bytes.

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

Transforms this Read instance to an Iterator over chars.

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

Creates an adaptor which will chain this stream with another.

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

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

impl<'a> Read for &'a UnixStream

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.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

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

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

Transforms this Read instance to an Iterator over its bytes.

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

Transforms this Read instance to an Iterator over chars.

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

Creates an adaptor which will chain this stream with another.

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

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

impl Write for UnixStream

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

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

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

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

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

Attempts to write an entire buffer into this write.

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

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

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

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

impl<'a> Write for &'a UnixStream

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

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

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

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

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

Attempts to write an entire buffer into this write.

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

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

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

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

impl AsRawFd for UnixStream

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl FromRawFd for UnixStream

unsafe fn from_raw_fd(fd: RawFd) -> UnixStream

Constructs a new instances of Self from the given raw file descriptor.

impl IntoRawFd for UnixStream

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.