1.10.0[−][src]Struct std::os::unix::net::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]
pub 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
pub 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
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 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
pub 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
pub 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
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. An Err
is returned if the zero Duration
is passed 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
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; let socket = UnixStream::connect("/tmp/sock").unwrap(); let result = socket.set_read_timeout(Some(Duration::new(0, 0))); let err = result.unwrap_err(); assert_eq!(err.kind(), io::ErrorKind::InvalidInput)Run
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. An Err
is returned if the zero Duration
is
passed 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
An Err
is returned if the zero Duration
is passed to this
method:
use std::io; use std::net::UdpSocket; use std::time::Duration; let socket = UdpSocket::bind("127.0.0.1:34254").unwrap(); let result = socket.set_write_timeout(Some(Duration::new(0, 0))); let err = result.unwrap_err(); assert_eq!(err.kind(), io::ErrorKind::InvalidInput)Run
pub 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
pub 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
pub 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
pub 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
Platform specific
On Redox this always returns None
.
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
).
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 Read for UnixStream
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[src]
fn read_vectored(&mut self, bufs: &mut [IoSliceMut]) -> Result<usize>
[src]
unsafe fn initializer(&self) -> Initializer
[src]
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, appending them to 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
ⓘImportant traits for &'_ mut Ffn 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
ⓘImportant traits for Bytes<R>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
ⓘImportant traits for Chain<T, U>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
ⓘImportant traits for Take<T>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]
fn read_vectored(&mut self, bufs: &mut [IoSliceMut]) -> Result<usize>
[src]
unsafe fn initializer(&self) -> Initializer
[src]
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, appending them to 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
ⓘImportant traits for &'_ mut Ffn 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
ⓘImportant traits for Bytes<R>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
ⓘImportant traits for Chain<T, U>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
ⓘImportant traits for Take<T>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]
fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize>
[src]
fn flush(&mut self) -> Result<()>
[src]
fn write_all(&mut self, buf: &[u8]) -> Result<()>
1.0.0[src]
Attempts to write an entire buffer into this writer. 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
ⓘImportant traits for &'_ mut Ffn 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]
fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize>
[src]
fn flush(&mut self) -> Result<()>
[src]
fn write_all(&mut self, buf: &[u8]) -> Result<()>
1.0.0[src]
Attempts to write an entire buffer into this writer. 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
ⓘImportant traits for &'_ mut Ffn 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]
impl FromRawFd for UnixStream
[src]
ⓘImportant traits for UnixStreamunsafe fn from_raw_fd(fd: RawFd) -> UnixStream
[src]
impl IntoRawFd for UnixStream
[src]
fn into_raw_fd(self) -> RawFd
[src]
impl Debug for UnixStream
[src]
Auto Trait Implementations
impl Send for UnixStream
impl Sync for UnixStream
Blanket Implementations
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
ⓘImportant traits for &'_ mut Ffn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,