pub struct UnixStream(_);
A Unix stream socket.
use 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(()) }
impl UnixStream
[src]
pub fn connect<P: AsRef<Path>>(path: P) -> Result<UnixStream>
[src]
Connects to the socket named by path
.
pub fn pair() -> Result<(UnixStream, UnixStream)>
[src]
Creates an unnamed pair of connected sockets.
Returns two UnixStream
s which are connected to each other.
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.
pub fn local_addr(&self) -> Result<SocketAddr>
[src]
Returns the socket address of the local half of this connection.
pub fn peer_addr(&self) -> Result<SocketAddr>
[src]
Returns the socket address of the remote half of this connection.
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.
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(()) }
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.
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::net::UdpSocket; use std::time::Duration; fn main() -> std::io::Result<()> { let socket = UdpSocket::bind("127.0.0.1:34254")?; let result = socket.set_write_timeout(Some(Duration::new(0, 0))); let err = result.unwrap_err(); assert_eq!(err.kind(), io::ErrorKind::InvalidInput); Ok(()) }
pub fn read_timeout(&self) -> Result<Option<Duration>>
[src]
Returns the read timeout of this socket.
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"); assert_eq!(socket.read_timeout()?, Some(Duration::new(1, 0))); Ok(()) }
pub fn write_timeout(&self) -> Result<Option<Duration>>
[src]
Returns the write timeout of this socket.
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"); assert_eq!(socket.write_timeout()?, Some(Duration::new(1, 0))); Ok(()) }
pub fn set_nonblocking(&self, nonblocking: bool) -> Result<()>
[src]
Moves the socket into or out of nonblocking mode.
pub fn take_error(&self) -> Result<Option<Error>>
[src]
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(()) }
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
).
impl AsRawFd for UnixStream
[src]
impl Debug for UnixStream
[src]
impl FromRawFd for UnixStream
[src]
unsafe fn from_raw_fd(fd: RawFd) -> UnixStreamβ
[src]
impl IntoRawFd for UnixStream
[src]
fn into_raw_fd(self) -> RawFd
[src]
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]
fn is_read_vectored(&self) -> bool
[src]
unsafe fn initializer(&self) -> Initializer
[src]
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>
[src]1.0.0
fn read_to_string(&mut self, buf: &mut String) -> Result<usize>
[src]1.0.0
fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>
[src]1.6.0
fn by_ref(&mut self) -> &mut SelfβNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized,
type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W
where
Self: Sized,
[src]1.0.0
fn bytes(self) -> Bytes<Self>β where
Self: Sized,
[src]1.0.0
fn chain<R: Read>(self, next: R) -> Chain<Self, R>β where
Self: Sized,
[src]1.0.0
fn take(self, limit: u64) -> Take<Self>β where
Self: Sized,
[src]1.0.0
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]
fn is_read_vectored(&self) -> bool
[src]
unsafe fn initializer(&self) -> Initializer
[src]
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>
[src]1.0.0
fn read_to_string(&mut self, buf: &mut String) -> Result<usize>
[src]1.0.0
fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>
[src]1.6.0
fn by_ref(&mut self) -> &mut SelfβNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized,
type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W
where
Self: Sized,
[src]1.0.0
fn bytes(self) -> Bytes<Self>β where
Self: Sized,
[src]1.0.0
fn chain<R: Read>(self, next: R) -> Chain<Self, R>β where
Self: Sized,
[src]1.0.0
fn take(self, limit: u64) -> Take<Self>β where
Self: Sized,
[src]1.0.0
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 is_write_vectored(&self) -> bool
[src]
fn flush(&mut self) -> Result<()>
[src]
fn write_all(&mut self, buf: &[u8]) -> Result<()>
[src]1.0.0
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<()>
[src]
fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<()>
[src]1.0.0
fn by_ref(&mut self) -> &mut SelfβNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized,
type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W
where
Self: Sized,
[src]1.0.0
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 is_write_vectored(&self) -> bool
[src]
fn flush(&mut self) -> Result<()>
[src]
fn write_all(&mut self, buf: &[u8]) -> Result<()>
[src]1.0.0
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<()>
[src]
fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<()>
[src]1.0.0
fn by_ref(&mut self) -> &mut SelfβNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized,
type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W
where
Self: Sized,
[src]1.0.0
impl RefUnwindSafe for UnixStream
impl Send for UnixStream
impl Sync for UnixStream
impl Unpin for UnixStream
impl UnwindSafe for UnixStream
impl<T> Any for T where
T: 'static + ?Sized,
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
fn borrow(&self) -> &TβNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized,
type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
fn borrow_mut(&mut self) -> &mut TβNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized,
type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized,
type Item = <I as Iterator>::Item;
impl<R: Read + ?Sized, '_> Read for &'_ mut R
impl<W: Write + ?Sized, '_> Write for &'_ mut W
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
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]
Β© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/os/unix/net/struct.UnixStream.html