Struct std::os::unix::net::UnixStream 1.10.0
[−]
[src]
pub struct UnixStream(_);
A Unix stream socket.
Examples
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);Run
Methods
impl UnixStream
[src]
fn connect<P: AsRef<Path>>(path: P) -> Result<UnixStream>
[src]
Connects to the socket named by path
.
Examples
use std::os::unix::net::UnixStream; let socket = match UnixStream::connect("/tmp/sock") { Ok(sock) => sock, Err(e) => { println!("Couldn't connect: {:?}", e); return } };Run
fn pair() -> Result<(UnixStream, UnixStream)>
[src]
Creates an unnamed pair of connected sockets.
Returns two UnixStream
s which are connected to each other.
Examples
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 } };Run
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 propagated to the other
stream.
Examples
use std::os::unix::net::UnixStream; let socket = UnixStream::connect("/tmp/sock").unwrap(); let sock_copy = socket.try_clone().expect("Couldn't clone socket");Run
fn local_addr(&self) -> Result<SocketAddr>
[src]
Returns the socket address of the local half of this connection.
Examples
use std::os::unix::net::UnixStream; let socket = UnixStream::connect("/tmp/sock").unwrap(); let addr = socket.local_addr().expect("Couldn't get local address");Run
fn peer_addr(&self) -> Result<SocketAddr>
[src]
Returns the socket address of the remote half of this connection.
Examples
use std::os::unix::net::UnixStream; let socket = UnixStream::connect("/tmp/sock").unwrap(); let addr = socket.peer_addr().expect("Couldn't get peer address");Run
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.
Examples
use std::os::unix::net::UnixStream; use std::time::Duration; let socket = UnixStream::connect("/tmp/sock").unwrap(); socket.set_read_timeout(Some(Duration::new(1, 0))).expect("Couldn't set read timeout");Run
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.
Examples
use std::os::unix::net::UnixStream; use std::time::Duration; let socket = UnixStream::connect("/tmp/sock").unwrap(); socket.set_write_timeout(Some(Duration::new(1, 0))).expect("Couldn't set write timeout");Run
fn read_timeout(&self) -> Result<Option<Duration>>
[src]
Returns the read timeout of this socket.
Examples
use std::os::unix::net::UnixStream; use std::time::Duration; let socket = UnixStream::connect("/tmp/sock").unwrap(); socket.set_read_timeout(Some(Duration::new(1, 0))).expect("Couldn't set read timeout"); assert_eq!(socket.read_timeout().unwrap(), Some(Duration::new(1, 0)));Run
fn write_timeout(&self) -> Result<Option<Duration>>
[src]
Returns the write timeout of this socket.
Examples
use std::os::unix::net::UnixStream; use std::time::Duration; let socket = UnixStream::connect("/tmp/sock").unwrap(); socket.set_write_timeout(Some(Duration::new(1, 0))).expect("Couldn't set write timeout"); assert_eq!(socket.write_timeout().unwrap(), Some(Duration::new(1, 0)));Run
fn set_nonblocking(&self, nonblocking: bool) -> Result<()>
[src]
Moves the socket into or out of nonblocking mode.
Examples
use std::os::unix::net::UnixStream; let socket = UnixStream::connect("/tmp/sock").unwrap(); socket.set_nonblocking(true).expect("Couldn't set nonblocking");Run
fn take_error(&self) -> Result<Option<Error>>
[src]
Returns the value of the SO_ERROR
option.
Examples
use std::os::unix::net::UnixStream; let socket = UnixStream::connect("/tmp/sock").unwrap(); if let Ok(Some(err)) = socket.take_error() { println!("Got error: {:?}", err); }Run
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
).
Examples
use std::os::unix::net::UnixStream; use std::net::Shutdown; let socket = UnixStream::connect("/tmp/sock").unwrap(); socket.shutdown(Shutdown::Both).expect("shutdown function failed");Run
Trait Implementations
impl Debug for UnixStream
[src]
impl Read for UnixStream
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[src]
Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
unsafe fn initializer(&self) -> Initializer
[src]
Determines if this Read
er can work with buffers of uninitialized memory. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>
1.0.0[src]
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize>
1.0.0[src]
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>
1.6.0[src]
Read the exact number of bytes required to fill buf
. Read more
fn by_ref(&mut self) -> &mut Self where
Self: Sized,
1.0.0[src]
Self: Sized,
Creates a "by reference" adaptor for this instance of Read
. Read more
fn bytes(self) -> Bytes<Self> where
Self: Sized,
1.0.0[src]
Self: Sized,
Transforms this Read
instance to an [Iterator
] over its bytes. Read more
fn chars(self) -> Chars<Self> where
Self: Sized,
[src]
Self: Sized,
🔬 This is a nightly-only experimental API. (io
#27802)
the semantics of a partial read/write of where errors happen is currently unclear and may change
Transforms this Read
instance to an [Iterator
] over [char
]s. Read more
fn chain<R: Read>(self, next: R) -> Chain<Self, R> where
Self: Sized,
1.0.0[src]
Self: Sized,
Creates an adaptor which will chain this stream with another. Read more
fn take(self, limit: u64) -> Take<Self> where
Self: Sized,
1.0.0[src]
Self: Sized,
Creates an adaptor which will read at most limit
bytes from it. Read more
impl<'a> Read for &'a UnixStream
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[src]
Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
unsafe fn initializer(&self) -> Initializer
[src]
Determines if this Read
er can work with buffers of uninitialized memory. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>
1.0.0[src]
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize>
1.0.0[src]
Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>
1.6.0[src]
Read the exact number of bytes required to fill buf
. Read more
fn by_ref(&mut self) -> &mut Self where
Self: Sized,
1.0.0[src]
Self: Sized,
Creates a "by reference" adaptor for this instance of Read
. Read more
fn bytes(self) -> Bytes<Self> where
Self: Sized,
1.0.0[src]
Self: Sized,
Transforms this Read
instance to an [Iterator
] over its bytes. Read more
fn chars(self) -> Chars<Self> where
Self: Sized,
[src]
Self: Sized,
🔬 This is a nightly-only experimental API. (io
#27802)
the semantics of a partial read/write of where errors happen is currently unclear and may change
Transforms this Read
instance to an [Iterator
] over [char
]s. Read more
fn chain<R: Read>(self, next: R) -> Chain<Self, R> where
Self: Sized,
1.0.0[src]
Self: Sized,
Creates an adaptor which will chain this stream with another. Read more
fn take(self, limit: u64) -> Take<Self> where
Self: Sized,
1.0.0[src]
Self: Sized,
Creates an adaptor which will read at most limit
bytes from it. Read more
impl Write for UnixStream
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
[src]
Write a buffer into this object, returning how many bytes were written. Read more
fn flush(&mut self) -> Result<()>
[src]
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
fn write_all(&mut self, buf: &[u8]) -> Result<()>
1.0.0[src]
Attempts to write an entire buffer into this write. Read more
fn write_fmt(&mut self, fmt: Arguments) -> Result<()>
1.0.0[src]
Writes a formatted string into this writer, returning any error encountered. Read more
fn by_ref(&mut self) -> &mut Self where
Self: Sized,
1.0.0[src]
Self: Sized,
Creates a "by reference" adaptor for this instance of Write
. Read more
impl<'a> Write for &'a UnixStream
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
[src]
Write a buffer into this object, returning how many bytes were written. Read more
fn flush(&mut self) -> Result<()>
[src]
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
fn write_all(&mut self, buf: &[u8]) -> Result<()>
1.0.0[src]
Attempts to write an entire buffer into this write. Read more
fn write_fmt(&mut self, fmt: Arguments) -> Result<()>
1.0.0[src]
Writes a formatted string into this writer, returning any error encountered. Read more
fn by_ref(&mut self) -> &mut Self where
Self: Sized,
1.0.0[src]
Self: Sized,
Creates a "by reference" adaptor for this instance of Write
. Read more
impl AsRawFd for UnixStream
[src]
fn as_raw_fd(&self) -> RawFd
[src]
Extracts the raw file descriptor. Read more
impl FromRawFd for UnixStream
[src]
unsafe fn from_raw_fd(fd: RawFd) -> UnixStream
[src]
Constructs a new instance of Self
from the given raw file descriptor. Read more
impl IntoRawFd for UnixStream
[src]
fn into_raw_fd(self) -> RawFd
[src]
Consumes this object, returning the raw underlying file descriptor. Read more