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]
[−]
impl UnixStream
pub fn connect<P: AsRef<Path>>(path: P) -> Result<UnixStream>
[src]
[−]
pub fn connect<P: AsRef<Path>>(path: P) -> Result<UnixStream>
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]
[−]
pub fn pair() -> Result<(UnixStream, UnixStream)>
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]
[−]
pub fn try_clone(&self) -> Result<UnixStream>
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]
[−]
pub fn local_addr(&self) -> Result<SocketAddr>
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]
[−]
pub fn peer_addr(&self) -> Result<SocketAddr>
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]
[−]
pub fn set_read_timeout(&self, timeout: Option<Duration>) -> Result<()>
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]
[−]
pub fn set_write_timeout(&self, timeout: Option<Duration>) -> Result<()>
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]
[−]
pub fn read_timeout(&self) -> Result<Option<Duration>>
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]
[−]
pub fn write_timeout(&self) -> Result<Option<Duration>>
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]
[−]
pub fn set_nonblocking(&self, nonblocking: bool) -> Result<()>
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]
[−]
pub fn take_error(&self) -> Result<Option<Error>>
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]
[−]
pub fn shutdown(&self, how: Shutdown) -> Result<()>
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]
[+]
impl Read for UnixStream
impl<'a> Read for &'a UnixStream
[src]
[+]
impl<'a> Read for &'a UnixStream
impl Write for UnixStream
[src]
[+]
impl Write for UnixStream
impl<'a> Write for &'a UnixStream
[src]
[+]
impl<'a> Write for &'a UnixStream
impl AsRawFd for UnixStream
[src]
[+]
impl AsRawFd for UnixStream
impl FromRawFd for UnixStream
[src]
[+]
impl FromRawFd for UnixStream
impl IntoRawFd for UnixStream
[src]
[+]
impl IntoRawFd for UnixStream
impl Debug for UnixStream
[src]
[+]
impl Debug for UnixStream
Auto Trait Implementations
impl Send for UnixStream
impl Send for UnixStream
impl Sync for UnixStream
impl Sync for UnixStream
Blanket Implementations
impl<T, U> TryFrom for T where
T: From<U>,
[src]
[−]
impl<T, U> TryFrom for T where
T: From<U>,
type Error = !
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
[−]
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.
impl<T> From for T
[src]
[−]
impl<T> From for T
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
[−]
impl<T, U> TryInto for T where
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]
[−]
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.
impl<T, U> Into for T where
U: From<T>,
[src]
[−]
impl<T, U> Into for T where
U: From<T>,
impl<T> Borrow for T where
T: ?Sized,
[src]
[−]
impl<T> Borrow for T where
T: ?Sized,
ⓘImportant traits for &'a mut Ifn borrow(&self) -> &T
[src]
[−]
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
impl<T> BorrowMut for T where
T: ?Sized,
[src]
[−]
impl<T> BorrowMut for T where
T: ?Sized,
ⓘImportant traits for &'a mut Ifn borrow_mut(&mut self) -> &mut T
[src]
[−]
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Any for T where
T: 'static + ?Sized,
[src]
[−]
impl<T> Any for T where
T: 'static + ?Sized,