Struct orkhon::prelude::ops::nn::tract_downcast_rs::__std::os::unix::net::UnixStream 1.10.0[−][src]
A Unix stream socket.
Examples
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(()) }
Implementations
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; fn main() -> std::io::Result<()> { let socket = UnixStream::connect("/tmp/sock")?; let sock_copy = socket.try_clone().expect("Couldn't clone socket"); Ok(()) }
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; fn main() -> std::io::Result<()> { let socket = UnixStream::connect("/tmp/sock")?; let addr = socket.local_addr().expect("Couldn't get local address"); Ok(()) }
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; fn main() -> std::io::Result<()> { let socket = UnixStream::connect("/tmp/sock")?; let addr = socket.peer_addr().expect("Couldn't get peer address"); Ok(()) }
pub fn peer_cred(&self) -> Result<UCred, Error>
[src]
🔬 This is a nightly-only experimental API. (peer_credentials_unix_socket
)
unstable
Gets the peer credentials for this Unix domain socket.
Examples
#![feature(peer_credentials_unix_socket)] use std::os::unix::net::UnixStream; fn main() -> std::io::Result<()> { let socket = UnixStream::connect("/tmp/sock")?; let peer_cred = socket.peer_cred().expect("Couldn't get peer credentials"); Ok(()) }
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; 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<(), 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; 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>, Error>
[src]
Returns the read timeout of this socket.
Examples
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>, Error>
[src]
Returns the write timeout of this socket.
Examples
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<(), Error>
[src]
Moves the socket into or out of nonblocking mode.
Examples
use std::os::unix::net::UnixStream; fn main() -> std::io::Result<()> { let socket = UnixStream::connect("/tmp/sock")?; socket.set_nonblocking(true).expect("Couldn't set nonblocking"); Ok(()) }
pub fn set_passcred(&self, passcred: bool) -> Result<(), Error>
[src]
unix_socket_ancillary_data
)Moves the socket to pass unix credentials as control message in SocketAncillary
.
Set the socket option SO_PASSCRED
.
Examples
#![feature(unix_socket_ancillary_data)] use std::os::unix::net::UnixStream; fn main() -> std::io::Result<()> { let socket = UnixStream::connect("/tmp/sock")?; socket.set_passcred(true).expect("Couldn't set passcred"); Ok(()) }
pub fn passcred(&self) -> Result<bool, Error>
[src]
unix_socket_ancillary_data
)Get the current value of the socket for passing unix credentials in SocketAncillary
.
This value can be change by set_passcred
.
Get the socket option SO_PASSCRED
.
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; fn main() -> std::io::Result<()> { let socket = UnixStream::connect("/tmp/sock")?; if let Ok(Some(err)) = socket.take_error() { println!("Got error: {:?}", err); } Ok(()) }
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; fn main() -> std::io::Result<()> { let socket = UnixStream::connect("/tmp/sock")?; socket.shutdown(Shutdown::Both).expect("shutdown function failed"); Ok(()) }
pub fn peek(&self, buf: &mut [u8]) -> Result<usize, Error>
[src]
unix_socket_peek
)Receives data on the socket from the remote address to which it is connected, without removing that data from the queue. On success, returns the number of bytes peeked.
Successive calls return the same data. This is accomplished by passing
MSG_PEEK
as a flag to the underlying recv
system call.
Examples
#![feature(unix_socket_peek)] use std::os::unix::net::UnixStream; fn main() -> std::io::Result<()> { let socket = UnixStream::connect("/tmp/sock")?; let mut buf = [0; 10]; let len = socket.peek(&mut buf).expect("peek failed"); Ok(()) }
pub fn recv_vectored_with_ancillary(
&self,
bufs: &mut [IoSliceMut<'_>],
ancillary: &mut SocketAncillary<'_>
) -> Result<usize, Error>
[src]
&self,
bufs: &mut [IoSliceMut<'_>],
ancillary: &mut SocketAncillary<'_>
) -> Result<usize, Error>
unix_socket_ancillary_data
)Receives data and ancillary data from socket.
On success, returns the number of bytes read.
Examples
#![feature(unix_socket_ancillary_data)] use std::os::unix::net::{UnixStream, SocketAncillary, AncillaryData}; use std::io::IoSliceMut; fn main() -> std::io::Result<()> { let socket = UnixStream::connect("/tmp/sock")?; let mut buf1 = [1; 8]; let mut buf2 = [2; 16]; let mut buf3 = [3; 8]; let mut bufs = &mut [ IoSliceMut::new(&mut buf1), IoSliceMut::new(&mut buf2), IoSliceMut::new(&mut buf3), ][..]; let mut fds = [0; 8]; let mut ancillary_buffer = [0; 128]; let mut ancillary = SocketAncillary::new(&mut ancillary_buffer[..]); let size = socket.recv_vectored_with_ancillary(bufs, &mut ancillary)?; println!("received {}", size); for ancillary_result in ancillary.messages() { if let AncillaryData::ScmRights(scm_rights) = ancillary_result.unwrap() { for fd in scm_rights { println!("receive file descriptor: {}", fd); } } } Ok(()) }
pub fn send_vectored_with_ancillary(
&self,
bufs: &mut [IoSliceMut<'_>],
ancillary: &mut SocketAncillary<'_>
) -> Result<usize, Error>
[src]
&self,
bufs: &mut [IoSliceMut<'_>],
ancillary: &mut SocketAncillary<'_>
) -> Result<usize, Error>
unix_socket_ancillary_data
)Sends data and ancillary data on the socket.
On success, returns the number of bytes written.
Examples
#![feature(unix_socket_ancillary_data)] use std::os::unix::net::{UnixStream, SocketAncillary}; use std::io::IoSliceMut; fn main() -> std::io::Result<()> { let socket = UnixStream::connect("/tmp/sock")?; let mut buf1 = [1; 8]; let mut buf2 = [2; 16]; let mut buf3 = [3; 8]; let mut bufs = &mut [ IoSliceMut::new(&mut buf1), IoSliceMut::new(&mut buf2), IoSliceMut::new(&mut buf3), ][..]; let fds = [0, 1, 2]; let mut ancillary_buffer = [0; 128]; let mut ancillary = SocketAncillary::new(&mut ancillary_buffer[..]); ancillary.add_fds(&fds[..]); socket.send_vectored_with_ancillary(bufs, &mut ancillary).expect("send_vectored_with_ancillary function failed"); Ok(()) }
Trait Implementations
impl AsRawFd for UnixStream
[src]
impl Debug for UnixStream
[src]
impl FromRawFd for UnixStream
[src]
pub unsafe fn from_raw_fd(fd: i32) -> UnixStreamⓘNotable traits for &'a UnixStream
impl<'a> Read for &'a UnixStreamimpl Read for UnixStreamimpl<'a> Write for &'a UnixStreamimpl Write for UnixStream
[src]
Notable traits for &'a UnixStream
impl<'a> Read for &'a UnixStreamimpl Read for UnixStreamimpl<'a> Write for &'a UnixStreamimpl Write for UnixStream
impl IntoRawFd for UnixStream
[src]
pub fn into_raw_fd(self) -> i32
[src]
impl<'a> Read for &'a UnixStream
[src]
pub fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>
[src]
pub fn read_vectored(
&mut self,
bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>
[src]
&mut self,
bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>
pub fn is_read_vectored(&self) -> bool
[src]
pub unsafe fn initializer(&self) -> Initializer
[src]
pub fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
1.0.0[src]
pub fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
pub fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
pub fn by_ref(&mut self) -> &mut SelfⓘNotable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;
1.0.0[src]
Notable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;
pub fn bytes(self) -> Bytes<Self>ⓘ
1.0.0[src]
pub fn chain<R>(self, next: R) -> Chain<Self, R>ⓘ where
R: Read,
1.0.0[src]
R: Read,
pub fn take(self, limit: u64) -> Take<Self>ⓘ
1.0.0[src]
impl Read for UnixStream
[src]
pub fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>
[src]
pub fn read_vectored(
&mut self,
bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>
[src]
&mut self,
bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>
pub fn is_read_vectored(&self) -> bool
[src]
pub unsafe fn initializer(&self) -> Initializer
[src]
pub fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
1.0.0[src]
pub fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
pub fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
pub fn by_ref(&mut self) -> &mut SelfⓘNotable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;
1.0.0[src]
Notable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;
pub fn bytes(self) -> Bytes<Self>ⓘ
1.0.0[src]
pub fn chain<R>(self, next: R) -> Chain<Self, R>ⓘ where
R: Read,
1.0.0[src]
R: Read,
pub fn take(self, limit: u64) -> Take<Self>ⓘ
1.0.0[src]
impl<'a> Write for &'a UnixStream
[src]
pub fn write(&mut self, buf: &[u8]) -> Result<usize, Error>
[src]
pub fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>
[src]
pub fn is_write_vectored(&self) -> bool
[src]
pub fn flush(&mut self) -> Result<(), Error>
[src]
pub fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
pub fn write_all_vectored(
&mut self,
bufs: &mut [IoSlice<'_>]
) -> Result<(), Error>
[src]
&mut self,
bufs: &mut [IoSlice<'_>]
) -> Result<(), Error>
pub fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>
1.0.0[src]
pub fn by_ref(&mut self) -> &mut SelfⓘNotable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;
1.0.0[src]
Notable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;
impl Write for UnixStream
[src]
pub fn write(&mut self, buf: &[u8]) -> Result<usize, Error>
[src]
pub fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>
[src]
pub fn is_write_vectored(&self) -> bool
[src]
pub fn flush(&mut self) -> Result<(), Error>
[src]
pub fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
pub fn write_all_vectored(
&mut self,
bufs: &mut [IoSlice<'_>]
) -> Result<(), Error>
[src]
&mut self,
bufs: &mut [IoSlice<'_>]
) -> Result<(), Error>
pub fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>
1.0.0[src]
pub fn by_ref(&mut self) -> &mut SelfⓘNotable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;
1.0.0[src]
Notable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;
Auto Trait Implementations
impl RefUnwindSafe for UnixStream
[src]
impl Send for UnixStream
[src]
impl Sync for UnixStream
[src]
impl Unpin for UnixStream
[src]
impl UnwindSafe for UnixStream
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow(&self) -> &TⓘNotable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;
[src]
Notable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;
[src]
Notable traits for &'_ mut R
impl<'_, R> Read for &'_ mut R where
R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where
W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;
impl<T> Downcast for T where
T: Any,
T: Any,
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<R, Global>
impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
A: Allocator + 'static,
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
Notable traits for Box<R, Global>
impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
A: Allocator + 'static,
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn as_any(&self) -> &(dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
impl<T> DowncastSync for T where
T: Send + Sync + Any,
T: Send + Sync + Any,
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.
pub 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>,