pub struct UnixStream { /* fields omitted */ }
A Unix stream socket.
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);
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.
use unix_socket::UnixStream;
let stream = UnixStream::connect("/path/to/my/socket").unwrap();
As connect
, but time out after a specified duration.
Creates an unnamed pair of connected sockets.
Returns two UnixStream
s which are connected to each other.
use unix_socket::UnixStream;
let (stream1, stream2) = UnixStream::pair().unwrap();
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.
use unix_socket::UnixStream;
let stream = UnixStream::connect("/path/to/my/socket").unwrap();
let copy = stream.try_clone().unwrap();
Returns the socket address of the local half of this connection.
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(),
});
Returns the socket address of the remote half of this connection.
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(),
});
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.
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();
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.
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();
Returns the read timeout of this socket.
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(),
});
Returns the write timeout of this socket.
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(),
});
Moves the socket into or out of nonblocking mode.
use unix_socket::UnixStream;
let stream = UnixStream::connect("/path/to/my/socket").unwrap();
stream.set_nonblocking(true).unwrap();
Returns the value of the SO_ERROR
option.
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(),
});
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
).
use std::net::Shutdown;
use unix_socket::UnixStream;
let stream = UnixStream::connect("/path/to/my/socket").unwrap();
stream.shutdown(Shutdown::Both).unwrap();
Formats the value using the given formatter. Read more
Consumes this object, returning the raw underlying file descriptor. Read more
Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
🔬 This is a nightly-only experimental API. (read_initializer
)
Determines if this Read
er can work with buffers of uninitialized memory. Read more
Read all bytes until EOF in this source, placing them into buf
. Read more
Read all bytes until EOF in this source, appending them to buf
. Read more
Read the exact number of bytes required to fill buf
. Read more
Creates a "by reference" adaptor for this instance of Read
. Read more
Transforms this Read
instance to an [Iterator
] over its bytes. Read more
Creates an adaptor which will chain this stream with another. Read more
Creates an adaptor which will read at most limit
bytes from it. Read more
Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
🔬 This is a nightly-only experimental API. (read_initializer
)
Determines if this Read
er can work with buffers of uninitialized memory. Read more
Read all bytes until EOF in this source, placing them into buf
. Read more
Read all bytes until EOF in this source, appending them to buf
. Read more
Read the exact number of bytes required to fill buf
. Read more
Creates a "by reference" adaptor for this instance of Read
. Read more
Transforms this Read
instance to an [Iterator
] over its bytes. Read more
Creates an adaptor which will chain this stream with another. Read more
Creates an adaptor which will read at most limit
bytes from it. Read more
Write a buffer into this writer, returning how many bytes were written. Read more
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
Attempts to write an entire buffer into this writer. Read more
Writes a formatted string into this writer, returning any error encountered. Read more
Creates a "by reference" adaptor for this instance of Write
. Read more
Write a buffer into this writer, returning how many bytes were written. Read more
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
Attempts to write an entire buffer into this writer. Read more
Writes a formatted string into this writer, returning any error encountered. Read more
Creates a "by reference" adaptor for this instance of Write
. Read more
Constructs a new instance of Self
from the given raw file descriptor. Read more
type Error = !
🔬 This is a nightly-only experimental API. (try_from
)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (try_from
)
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
type Error = <U as TryFrom<T>>::Error
🔬 This is a nightly-only experimental API. (try_from
)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (try_from
)
🔬 This is a nightly-only experimental API. (get_type_id
)
this method will likely be replaced by an associated static