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);
Methods
impl UnixStream
[src]
pub fn connect<P>(path: P) -> Result<UnixStream, Error> where
P: AsRef<Path>,
[src]
P: AsRef<Path>,
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 } };
pub fn pair() -> Result<(UnixStream, UnixStream), Error>
[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 } };
pub fn try_clone(&self) -> Result<UnixStream, Error>
[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");
pub fn local_addr(&self) -> Result<SocketAddr, Error>
[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");
pub fn peer_addr(&self) -> Result<SocketAddr, Error>
[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");
pub fn set_read_timeout(&self, timeout: Option<Duration>) -> Result<(), Error>
[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");
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)
pub fn set_write_timeout(&self, timeout: Option<Duration>) -> Result<(), Error>
[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");
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)
pub fn read_timeout(&self) -> Result<Option<Duration>, Error>
[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)));
pub fn write_timeout(&self) -> Result<Option<Duration>, Error>
[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)));
pub fn set_nonblocking(&self, nonblocking: bool) -> Result<(), Error>
[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");
pub fn take_error(&self) -> Result<Option<Error>, 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); }
Platform specific
On Redox this always returns None
.
pub fn shutdown(&self, how: Shutdown) -> Result<(), Error>
[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");
Trait Implementations
impl IntoRawFd for UnixStream
[src]
fn into_raw_fd(self) -> i32
[src]
impl Write for UnixStream
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize, Error>
[src]
fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>
[src]
fn flush(&mut self) -> Result<(), Error>
[src]
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0[src]
ⓘImportant traits for &'_ mut Wfn by_ref(&mut self) -> &mut Self
1.0.0[src]
impl<'a> Write for &'a UnixStream
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize, Error>
[src]
fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>
[src]
fn flush(&mut self) -> Result<(), Error>
[src]
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0[src]
ⓘImportant traits for &'_ mut Wfn by_ref(&mut self) -> &mut Self
1.0.0[src]
impl Debug for UnixStream
[src]
impl<'a> Read for &'a UnixStream
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>
[src]
fn read_vectored(&mut self, bufs: &mut [IoSliceMut]) -> Result<usize, Error>
[src]
unsafe fn initializer(&self) -> Initializer
[src]
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0[src]
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
ⓘImportant traits for &'_ mut Wfn by_ref(&mut self) -> &mut Self
1.0.0[src]
ⓘImportant traits for Bytes<R>fn bytes(self) -> Bytes<Self>
1.0.0[src]
ⓘImportant traits for Chain<T, U>fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0[src]
R: Read,
ⓘImportant traits for Take<T>fn take(self, limit: u64) -> Take<Self>
1.0.0[src]
impl Read for UnixStream
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>
[src]
fn read_vectored(&mut self, bufs: &mut [IoSliceMut]) -> Result<usize, Error>
[src]
unsafe fn initializer(&self) -> Initializer
[src]
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0[src]
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
ⓘImportant traits for &'_ mut Wfn by_ref(&mut self) -> &mut Self
1.0.0[src]
ⓘImportant traits for Bytes<R>fn bytes(self) -> Bytes<Self>
1.0.0[src]
ⓘImportant traits for Chain<T, U>fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0[src]
R: Read,
ⓘImportant traits for Take<T>fn take(self, limit: u64) -> Take<Self>
1.0.0[src]
impl AsRawFd for UnixStream
[src]
impl FromRawFd for UnixStream
[src]
ⓘImportant traits for UnixStreamunsafe fn from_raw_fd(fd: i32) -> UnixStream
[src]
Auto Trait Implementations
impl Unpin for UnixStream
impl Sync for UnixStream
impl Send for UnixStream
impl UnwindSafe for UnixStream
impl RefUnwindSafe for UnixStream
Blanket Implementations
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
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> 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> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
ⓘImportant traits for &'_ mut Wfn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,