Struct std::os::unix::net::UnixDatagram 1.10.0[−][src]
pub struct UnixDatagram(_);
A Unix datagram socket.
Examples
use std::os::unix::net::UnixDatagram; let socket = UnixDatagram::bind("/path/to/my/socket").unwrap(); socket.send_to(b"hello world", "/path/to/other/socket").unwrap(); let mut buf = [0; 100]; let (count, address) = socket.recv_from(&mut buf).unwrap(); println!("socket {:?} sent {:?}", address, &buf[..count]);Run
Methods
impl UnixDatagram[src]
impl UnixDatagrampub fn bind<P: AsRef<Path>>(path: P) -> Result<UnixDatagram>[src]
pub fn bind<P: AsRef<Path>>(path: P) -> Result<UnixDatagram>Creates a Unix datagram socket bound to the given path.
Examples
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 } };Run
pub fn unbound() -> Result<UnixDatagram>[src]
pub fn unbound() -> Result<UnixDatagram>Creates a Unix Datagram socket which is not bound to any address.
Examples
use std::os::unix::net::UnixDatagram; let sock = match UnixDatagram::unbound() { Ok(sock) => sock, Err(e) => { println!("Couldn't unbound: {:?}", e); return } };Run
pub fn pair() -> Result<(UnixDatagram, UnixDatagram)>[src]
pub fn pair() -> Result<(UnixDatagram, UnixDatagram)>Create an unnamed pair of connected sockets.
Returns two UnixDatagramss which are connected to each other.
Examples
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 } };Run
pub fn connect<P: AsRef<Path>>(&self, path: P) -> Result<()>[src]
pub fn connect<P: AsRef<Path>>(&self, path: P) -> Result<()>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.
Examples
use std::os::unix::net::UnixDatagram; let sock = UnixDatagram::unbound().unwrap(); match sock.connect("/path/to/the/socket") { Ok(sock) => sock, Err(e) => { println!("Couldn't connect: {:?}", e); return } };Run
pub fn try_clone(&self) -> Result<UnixDatagram>[src]
pub fn try_clone(&self) -> Result<UnixDatagram>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.
Examples
use std::os::unix::net::UnixDatagram; let sock = UnixDatagram::bind("/path/to/the/socket").unwrap(); let sock_copy = sock.try_clone().expect("try_clone failed");Run
pub fn local_addr(&self) -> Result<SocketAddr>[src]
pub fn local_addr(&self) -> Result<SocketAddr>Returns the address of this socket.
Examples
use std::os::unix::net::UnixDatagram; let sock = UnixDatagram::bind("/path/to/the/socket").unwrap(); let addr = sock.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 address of this socket's peer.
The connect method will connect the socket to a peer.
Examples
use std::os::unix::net::UnixDatagram; let sock = UnixDatagram::unbound().unwrap(); sock.connect("/path/to/the/socket").unwrap(); let addr = sock.peer_addr().expect("Couldn't get peer address");Run
pub fn recv_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr)>[src]
pub fn recv_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr)>Receives data from the socket.
On success, returns the number of bytes read and the address from whence the data came.
Examples
use std::os::unix::net::UnixDatagram; let sock = UnixDatagram::unbound().unwrap(); let mut buf = vec![0; 10]; match sock.recv_from(buf.as_mut_slice()) { Ok((size, sender)) => println!("received {} bytes from {:?}", size, sender), Err(e) => println!("recv_from function failed: {:?}", e), }Run
pub fn recv(&self, buf: &mut [u8]) -> Result<usize>[src]
pub fn recv(&self, buf: &mut [u8]) -> Result<usize>Receives data from the socket.
On success, returns the number of bytes read.
Examples
use std::os::unix::net::UnixDatagram; let sock = UnixDatagram::bind("/path/to/the/socket").unwrap(); let mut buf = vec![0; 10]; sock.recv(buf.as_mut_slice()).expect("recv function failed");Run
pub fn send_to<P: AsRef<Path>>(&self, buf: &[u8], path: P) -> Result<usize>[src]
pub fn send_to<P: AsRef<Path>>(&self, buf: &[u8], path: P) -> Result<usize>Sends data on the socket to the specified address.
On success, returns the number of bytes written.
Examples
use std::os::unix::net::UnixDatagram; let sock = UnixDatagram::unbound().unwrap(); sock.send_to(b"omelette au fromage", "/some/sock").expect("send_to function failed");Run
pub fn send(&self, buf: &[u8]) -> Result<usize>[src]
pub fn send(&self, buf: &[u8]) -> Result<usize>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.
Examples
use std::os::unix::net::UnixDatagram; let sock = UnixDatagram::unbound().unwrap(); sock.connect("/some/sock").expect("Couldn't connect"); sock.send(b"omelette au fromage").expect("send_to function failed");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 recv and recv_from calls will
block indefinitely. An Err is returned if the zero Duration
is passed to this method.
Examples
use std::os::unix::net::UnixDatagram; use std::time::Duration; let sock = UnixDatagram::unbound().unwrap(); sock.set_read_timeout(Some(Duration::new(1, 0))).expect("set_read_timeout function failed");Run
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; let socket = UnixDatagram::unbound().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 send and send_to calls will
block indefinitely. An Err is returned if the zero Duration is passed to this
method.
Examples
use std::os::unix::net::UnixDatagram; use std::time::Duration; let sock = UnixDatagram::unbound().unwrap(); sock.set_write_timeout(Some(Duration::new(1, 0))) .expect("set_write_timeout function failed");Run
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; let socket = UnixDatagram::unbound().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::UnixDatagram; use std::time::Duration; let sock = UnixDatagram::unbound().unwrap(); sock.set_read_timeout(Some(Duration::new(1, 0))).expect("set_read_timeout function failed"); assert_eq!(sock.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::UnixDatagram; use std::time::Duration; let sock = UnixDatagram::unbound().unwrap(); sock.set_write_timeout(Some(Duration::new(1, 0))) .expect("set_write_timeout function failed"); assert_eq!(sock.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::UnixDatagram; let sock = UnixDatagram::unbound().unwrap(); sock.set_nonblocking(true).expect("set_nonblocking function failed");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::UnixDatagram; let sock = UnixDatagram::unbound().unwrap(); if let Ok(Some(err)) = sock.take_error() { println!("Got error: {:?}", err); }Run
pub fn shutdown(&self, how: Shutdown) -> Result<()>[src]
pub fn shutdown(&self, how: Shutdown) -> Result<()>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; let sock = UnixDatagram::unbound().unwrap(); sock.shutdown(Shutdown::Both).expect("shutdown function failed");Run
Trait Implementations
impl Debug for UnixDatagram[src]
impl Debug for UnixDatagramfn fmt(&self, fmt: &mut Formatter) -> Result[src]
fn fmt(&self, fmt: &mut Formatter) -> ResultFormats the value using the given formatter. Read more
impl AsRawFd for UnixDatagram[src]
impl AsRawFd for UnixDatagramfn as_raw_fd(&self) -> RawFd[src]
fn as_raw_fd(&self) -> RawFdExtracts the raw file descriptor. Read more
impl FromRawFd for UnixDatagram[src]
impl FromRawFd for UnixDatagramunsafe fn from_raw_fd(fd: RawFd) -> UnixDatagram[src]
unsafe fn from_raw_fd(fd: RawFd) -> UnixDatagramConstructs a new instance of Self from the given raw file descriptor. Read more
impl IntoRawFd for UnixDatagram[src]
impl IntoRawFd for UnixDatagramfn into_raw_fd(self) -> RawFd[src]
fn into_raw_fd(self) -> RawFdConsumes this object, returning the raw underlying file descriptor. Read more
Auto Trait Implementations
impl Send for UnixDatagram
impl Send for UnixDatagramimpl Sync for UnixDatagram
impl Sync for UnixDatagram