[][src]Struct unix_socket::UnixStream

pub struct UnixStream { /* fields omitted */ }

A Unix stream socket.

Examples

use unix_socket::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[src]

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

Connects to the socket named by path.

Linux provides, as a nonportable extension, a separate "abstract" address namespace as opposed to filesystem-based addressing. If path begins with a null byte, it will be interpreted as an "abstract" address. Otherwise, it will be interpreted as a "pathname" address, corresponding to a path on the filesystem.

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

Creates an unnamed pair of connected sockets.

Returns two UnixStreams which are connected to each other.

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

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.

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

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

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

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

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

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.

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

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.

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

Returns the read timeout of this socket.

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

Returns the write timeout of this socket.

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

Moves the socket into or out of nonblocking mode.

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

Returns the value of the SO_ERROR option.

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

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]

impl Read for UnixStream[src]

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

impl Write for UnixStream[src]

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

impl AsRawFd for UnixStream[src]

impl FromRawFd for UnixStream[src]

impl IntoRawFd for UnixStream[src]

Auto Trait Implementations

impl Send for UnixStream

impl Sync for UnixStream

impl Unpin for UnixStream

impl UnwindSafe for UnixStream

impl RefUnwindSafe for UnixStream

Blanket Implementations

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

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

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.

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.

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

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

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