pub struct UnixDatagram(_);
A Unix datagram socket.
use std::os::unix::net::UnixDatagram; fn main() -> std::io::Result<()> { let socket = UnixDatagram::bind("/path/to/my/socket")?; socket.send_to(b"hello world", "/path/to/other/socket")?; let mut buf = [0; 100]; let (count, address) = socket.recv_from(&mut buf)?; println!("socket {:?} sent {:?}", address, &buf[..count]); Ok(()) }
impl UnixDatagram
[src]
pub fn bind<P: AsRef<Path>>(path: P) -> Result<UnixDatagram>
[src]
Creates a Unix datagram socket bound to the given path.
use std::os::unix::net::UnixDatagram; let sock = match UnixDatagram::bind("/path/to/the/socket") { Ok(sock) => sock, Err(e) => { println!("Couldn't bind: {:?}", e); return } };
pub fn unbound() -> Result<UnixDatagram>
[src]
Creates a Unix Datagram socket which is not bound to any address.
use std::os::unix::net::UnixDatagram; let sock = match UnixDatagram::unbound() { Ok(sock) => sock, Err(e) => { println!("Couldn't unbound: {:?}", e); return } };
pub fn pair() -> Result<(UnixDatagram, UnixDatagram)>
[src]
Creates an unnamed pair of connected sockets.
Returns two UnixDatagrams
s which are connected to each other.
use std::os::unix::net::UnixDatagram; let (sock1, sock2) = match UnixDatagram::pair() { Ok((sock1, sock2)) => (sock1, sock2), Err(e) => { println!("Couldn't unbound: {:?}", e); return } };
pub fn connect<P: AsRef<Path>>(&self, path: P) -> Result<()>
[src]
Connects the socket to the specified address.
The send
method may be used to send data to the specified address. recv
and recv_from
will only receive data from that address.
use std::os::unix::net::UnixDatagram; fn main() -> std::io::Result<()> { let sock = UnixDatagram::unbound()?; match sock.connect("/path/to/the/socket") { Ok(sock) => sock, Err(e) => { println!("Couldn't connect: {:?}", e); return Err(e) } }; Ok(()) }
pub fn try_clone(&self) -> Result<UnixDatagram>
[src]
Creates a new independently owned handle to the underlying socket.
The returned UnixDatagram
is a reference to the same socket that this object references. Both handles can be used to accept incoming connections and options set on one side will affect the other.
use std::os::unix::net::UnixDatagram; fn main() -> std::io::Result<()> { let sock = UnixDatagram::bind("/path/to/the/socket")?; let sock_copy = sock.try_clone().expect("try_clone failed"); Ok(()) }
pub fn local_addr(&self) -> Result<SocketAddr>
[src]
Returns the address of this socket.
use std::os::unix::net::UnixDatagram; fn main() -> std::io::Result<()> { let sock = UnixDatagram::bind("/path/to/the/socket")?; let addr = sock.local_addr().expect("Couldn't get local address"); Ok(()) }
pub fn peer_addr(&self) -> Result<SocketAddr>
[src]
Returns the address of this socket's peer.
The connect
method will connect the socket to a peer.
use std::os::unix::net::UnixDatagram; fn main() -> std::io::Result<()> { let sock = UnixDatagram::unbound()?; sock.connect("/path/to/the/socket")?; let addr = sock.peer_addr().expect("Couldn't get peer address"); Ok(()) }
pub fn recv_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr)>
[src]
Receives data from the socket.
On success, returns the number of bytes read and the address from whence the data came.
use std::os::unix::net::UnixDatagram; fn main() -> std::io::Result<()> { let sock = UnixDatagram::unbound()?; let mut buf = vec![0; 10]; let (size, sender) = sock.recv_from(buf.as_mut_slice())?; println!("received {} bytes from {:?}", size, sender); Ok(()) }
pub fn recv(&self, buf: &mut [u8]) -> Result<usize>
[src]
Receives data from the socket.
On success, returns the number of bytes read.
use std::os::unix::net::UnixDatagram; fn main() -> std::io::Result<()> { let sock = UnixDatagram::bind("/path/to/the/socket")?; let mut buf = vec![0; 10]; sock.recv(buf.as_mut_slice()).expect("recv function failed"); Ok(()) }
pub fn send_to<P: AsRef<Path>>(&self, buf: &[u8], path: P) -> Result<usize>
[src]
Sends data on the socket to the specified address.
On success, returns the number of bytes written.
use std::os::unix::net::UnixDatagram; fn main() -> std::io::Result<()> { let sock = UnixDatagram::unbound()?; sock.send_to(b"omelette au fromage", "/some/sock").expect("send_to function failed"); Ok(()) }
pub fn send(&self, buf: &[u8]) -> Result<usize>
[src]
Sends data on the socket to the socket's peer.
The peer address may be set by the connect
method, and this method will return an error if the socket has not already been connected.
On success, returns the number of bytes written.
use std::os::unix::net::UnixDatagram; fn main() -> std::io::Result<()> { let sock = UnixDatagram::unbound()?; sock.connect("/some/sock").expect("Couldn't connect"); sock.send(b"omelette au fromage").expect("send_to function failed"); Ok(()) }
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 recv
and recv_from
calls will block indefinitely. An Err
is returned if the zero Duration
is passed to this method.
use std::os::unix::net::UnixDatagram; use std::time::Duration; fn main() -> std::io::Result<()> { let sock = UnixDatagram::unbound()?; sock.set_read_timeout(Some(Duration::new(1, 0))) .expect("set_read_timeout function failed"); Ok(()) }
An Err
is returned if the zero Duration
is passed to this method:
use std::io; use std::os::unix::net::UnixDatagram; use std::time::Duration; fn main() -> std::io::Result<()> { let socket = UnixDatagram::unbound()?; 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 send
and send_to
calls will block indefinitely. An Err
is returned if the zero Duration
is passed to this method.
use std::os::unix::net::UnixDatagram; use std::time::Duration; fn main() -> std::io::Result<()> { let sock = UnixDatagram::unbound()?; sock.set_write_timeout(Some(Duration::new(1, 0))) .expect("set_write_timeout function failed"); Ok(()) }
An Err
is returned if the zero Duration
is passed to this method:
use std::io; use std::os::unix::net::UnixDatagram; use std::time::Duration; fn main() -> std::io::Result<()> { let socket = UnixDatagram::unbound()?; 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::UnixDatagram; use std::time::Duration; fn main() -> std::io::Result<()> { let sock = UnixDatagram::unbound()?; sock.set_read_timeout(Some(Duration::new(1, 0))) .expect("set_read_timeout function failed"); assert_eq!(sock.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::UnixDatagram; use std::time::Duration; fn main() -> std::io::Result<()> { let sock = UnixDatagram::unbound()?; sock.set_write_timeout(Some(Duration::new(1, 0))) .expect("set_write_timeout function failed"); assert_eq!(sock.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.
use std::os::unix::net::UnixDatagram; fn main() -> std::io::Result<()> { let sock = UnixDatagram::unbound()?; sock.set_nonblocking(true).expect("set_nonblocking function failed"); Ok(()) }
pub fn take_error(&self) -> Result<Option<Error>>
[src]
Returns the value of the SO_ERROR
option.
use std::os::unix::net::UnixDatagram; fn main() -> std::io::Result<()> { let sock = UnixDatagram::unbound()?; if let Ok(Some(err)) = sock.take_error() { println!("Got error: {:?}", err); } Ok(()) }
pub fn shutdown(&self, how: Shutdown) -> Result<()>
[src]
Shut 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
).
use std::os::unix::net::UnixDatagram; use std::net::Shutdown; fn main() -> std::io::Result<()> { let sock = UnixDatagram::unbound()?; sock.shutdown(Shutdown::Both).expect("shutdown function failed"); Ok(()) }
impl AsRawFd for UnixDatagram
[src]
impl Debug for UnixDatagram
[src]
impl FromRawFd for UnixDatagram
[src]
unsafe fn from_raw_fd(fd: RawFd) -> UnixDatagram
[src]
impl IntoRawFd for UnixDatagram
[src]
fn into_raw_fd(self) -> RawFd
[src]
impl RefUnwindSafe for UnixDatagram
impl Send for UnixDatagram
impl Sync for UnixDatagram
impl Unpin for UnixDatagram
impl UnwindSafe for UnixDatagram
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.UnixDatagram.html