Struct unix_socket::UnixStream

source ·

pub struct UnixStream { /* private fields */ }

Expand description

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

Implementations§

source §

impl UnixStream

source

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

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.

Examples

use unix_socket::UnixStream;

let stream = UnixStream::connect("/path/to/my/socket").unwrap();

source

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

Creates an unnamed pair of connected sockets.

Returns two UnixStreams which are connected to each other.

Examples

use unix_socket::UnixStream;

let (stream1, stream2) = UnixStream::pair().unwrap();

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

Examples

use unix_socket::UnixStream;

let stream = UnixStream::connect("/path/to/my/socket").unwrap();
let copy = stream.try_clone().unwrap();

source

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

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

Examples

use unix_socket::UnixStream;

let stream = UnixStream::connect("/path/to/my/socket").unwrap();
println!("{}", match stream.local_addr() {
    Ok(addr) => format!("local address: {:?}", addr),
    Err(_) => "no local address".to_owned(),
});

source

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

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

Examples

use unix_socket::UnixStream;

let stream = UnixStream::connect("/path/to/my/socket").unwrap();
println!("{}", match stream.peer_addr() {
    Ok(addr) => format!("peer address: {:?}", addr),
    Err(_) => "no peer address".to_owned(),
});

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. It is an error to pass the zero Duration to this method.

Examples

use unix_socket::UnixStream;
use std::time::Duration;

let stream = UnixStream::connect("/path/to/my/socket").unwrap();
stream.set_read_timeout(Some(Duration::from_millis(1500))).unwrap();

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. It is an error to pass the zero Duration to this method.

Examples

use unix_socket::UnixStream;
use std::time::Duration;

let stream = UnixStream::connect("/path/to/my/socket").unwrap();
stream.set_write_timeout(Some(Duration::from_millis(1500))).unwrap();

source

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

Returns the read timeout of this socket.

Examples

use unix_socket::UnixStream;

let stream = UnixStream::connect("/path/to/my/socket").unwrap();
println!("{}", match stream.read_timeout() {
    Ok(timeout) => format!("read timeout: {:?}", timeout),
    Err(_) => "error".to_owned(),
});

source

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

Returns the write timeout of this socket.

Examples

use unix_socket::UnixStream;

let stream = UnixStream::connect("/path/to/my/socket").unwrap();
println!("{}", match stream.write_timeout() {
    Ok(timeout) => format!("write timeout: {:?}", timeout),
    Err(_) => "error".to_owned(),
});

source

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

Moves the socket into or out of nonblocking mode.

Examples

use unix_socket::UnixStream;

let stream = UnixStream::connect("/path/to/my/socket").unwrap();
stream.set_nonblocking(true).unwrap();

source

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

Returns the value of the SO_ERROR option.

Examples

use unix_socket::UnixStream;

let stream = UnixStream::connect("/path/to/my/socket").unwrap();
println!("{}", match stream.take_error() {
    Ok(ret) => format!("error: {:?}", ret),
    Err(_) => "error".to_owned(),
});

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::net::Shutdown;
use unix_socket::UnixStream;

let stream = UnixStream::connect("/path/to/my/socket").unwrap();
stream.shutdown(Shutdown::Both).unwrap();