pub struct UnixStream();
Available on Unix only.
Expand descriptionA Unix stream socket.
§Examplesuse 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(())
}
Source§ 1.10.0 · Source
Connects to the socket named by path
.
use std::os::unix::net::UnixStream;
let socket = match UnixStream::connect("/tmp/sock") {
Ok(sock) => sock,
Err(e) => {
println!("Couldn't connect: {e:?}");
return
}
};
1.70.0 · Source
Connects to the socket specified by address
.
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(())
}
1.10.0 · Source
Creates an unnamed pair of connected sockets.
Returns two UnixStream
s which are connected to each other.
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
}
};
1.10.0 · Source
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.
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(())
}
1.10.0 · Source
Returns the socket address of the local half of this connection.
§Examplesuse 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(())
}
1.10.0 · Source
Returns the socket address of the remote half of this connection.
§Examplesuse 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(())
}
Source ð¬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(())
}
1.10.0 · Source
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.
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(())
}
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(())
}
1.10.0 · Source
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.
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(())
}
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_write_timeout(Some(Duration::new(0, 0)));
let err = result.unwrap_err();
assert_eq!(err.kind(), io::ErrorKind::InvalidInput);
Ok(())
}
1.10.0 · Source
Returns the read timeout of this socket.
§Examplesuse 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(())
}
1.10.0 · Source
Returns the write timeout of this socket.
§Examplesuse 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(())
}
1.10.0 · Source
Moves the socket into or out of nonblocking mode.
§Examplesuse 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(())
}
Source ð¬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(())
}
1.10.0 · Source
Returns the value of the SO_ERROR
option.
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(())
}
§Platform specific
On Redox this always returns None
.
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::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(())
}
Source ð¬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.
#![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(())
}
Source ð¬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(())
}
Source ð¬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(())
}
1.63.0 · Source§ 1.10.0 · Source§ 1.10.0 · Source§ 1.63.0 · Source§ Source§
Converts to this type from the input type.
1.63.0 · Source§ 1.10.0 · Source§ Source§Constructs a new instance of
Self
from the given raw file descriptor.
Read more 1.10.0 · Source§ Source§Consumes this object, returning the raw underlying file descriptor.
Read more 1.10.0 · Source§ Source§Pull some bytes from this source into the specified buffer, returning how many bytes were read.
Read more Source§ ð¬This is a nightly-only experimental API. (read_buf
#78485)
Pull some bytes from this source into the specified buffer.
Read more Source§Like
read
, except that it reads into a slice of buffers.
Read more Source§ ð¬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§Reads all bytes until EOF in this source, placing them into
buf
.
Read more 1.0.0 · Source§Reads all bytes until EOF in this source, appending them to
buf
.
Read more 1.6.0 · Source§Reads the exact number of bytes required to fill
buf
.
Read more Source§ ð¬This is a nightly-only experimental API. (read_buf
#78485)
Reads the exact number of bytes required to fill
cursor
.
Read more 1.0.0 · Source§Creates a âby referenceâ adaptor for this instance of
Read
.
Read more 1.0.0 · Source§ 1.0.0 · Source§Creates an adapter which will chain this stream with another.
Read more 1.0.0 · Source§Creates an adapter which will read at most
limit
bytes from it.
Read more 1.10.0 · Source§ Source§Pull some bytes from this source into the specified buffer, returning how many bytes were read.
Read more Source§ ð¬This is a nightly-only experimental API. (read_buf
#78485)
Pull some bytes from this source into the specified buffer.
Read more Source§Like
read
, except that it reads into a slice of buffers.
Read more Source§ ð¬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§Reads all bytes until EOF in this source, placing them into
buf
.
Read more 1.0.0 · Source§Reads all bytes until EOF in this source, appending them to
buf
.
Read more 1.6.0 · Source§Reads the exact number of bytes required to fill
buf
.
Read more Source§ ð¬This is a nightly-only experimental API. (read_buf
#78485)
Reads the exact number of bytes required to fill
cursor
.
Read more 1.0.0 · Source§Creates a âby referenceâ adaptor for this instance of
Read
.
Read more 1.0.0 · Source§ 1.0.0 · Source§Creates an adapter which will chain this stream with another.
Read more 1.0.0 · Source§Creates an adapter which will read at most
limit
bytes from it.
Read more Source§Available on Linux or Android only.
Source§ ð¬This is a nightly-only experimental API. (unix_socket_ancillary_data
#76915)
Available on Linux only.
Query the current setting of socket option SO_PASSCRED
.
unix_socket_ancillary_data
#76915)
Available on Linux only.
Enable or disable socket option
SO_PASSCRED
.
Read more 1.10.0 · Source§ Source§Writes a buffer into this writer, returning how many bytes were written.
Read more Source§ Source§ ð¬This is a nightly-only experimental API. (can_vector
#69941) Source§
Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.
Read more 1.0.0 · Source§Attempts to write an entire buffer into this writer.
Read more Source§ ð¬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§Writes a formatted string into this writer, returning any error encountered.
Read more 1.0.0 · Source§Creates a âby referenceâ adapter for this instance of
Write
.
Read more 1.10.0 · Source§ Source§Writes a buffer into this writer, returning how many bytes were written.
Read more Source§ Source§ ð¬This is a nightly-only experimental API. (can_vector
#69941) Source§
Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.
Read more 1.0.0 · Source§Attempts to write an entire buffer into this writer.
Read more Source§ ð¬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§Writes a formatted string into this writer, returning any error encountered.
Read more 1.0.0 · Source§Creates a âby referenceâ adapter for this instance of
Write
.
Read moreRetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4