Struct cap_async_std::net::UdpSocket [−][src]
A UDP socket.
This corresponds to async_std::net::UdpSocket
.
Note that this UdpSocket
has no bind
, connect
, or send_to
methods. To
create a UdpSocket
bound to an address or to send a message to an address,
you must first obtain a Catalog
permitting the address, and then call
Catalog::bind_udp_socket
, or Catalog::connect_udp_socket
, or
Catalog::send_to_udp_socket_addr
.
Implementations
impl UdpSocket
[src]
pub unsafe fn from_std(std: UdpSocket) -> Self
[src]
Constructs a new instance of Self
from the given async_std::net::UdpSocket
.
Safety
async_std::net::UdpSocket
is not sandboxed and may access any address that the host
process has access to.
pub async fn recv_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr)>
[src]
Receives a single datagram message on the socket.
This corresponds to async_std::net::UdpSocket::recv_from
.
pub fn peer_addr(&self) -> Result<SocketAddr>
[src]
Returns the socket address of the remote peer this socket was connected to.
This corresponds to async_std::net::UdpSocket::peer_addr
.
pub fn local_addr(&self) -> Result<SocketAddr>
[src]
Returns the socket address that this socket was created from.
This corresponds to async_std::net::UdpSocket::local_addr
.
pub fn set_broadcast(&self, broadcast: bool) -> Result<()>
[src]
Sets the value of the SO_BROADCAST
option for this socket.
This corresponds to async_std::net::UdpSocket::set_broadcast
.
pub fn broadcast(&self) -> Result<bool>
[src]
Gets the value of the SO_BROADCAST
option for this socket.
This corresponds to async_std::net::UdpSocket::broadcast
.
pub fn set_multicast_loop_v4(&self, multicast_loop_v4: bool) -> Result<()>
[src]
Sets the value of the IP_MULTICAST_LOOP
option for this socket.
This corresponds to async_std::net::UdpSocket::set_multicast_loop_v4
.
pub fn multicast_loop_v4(&self) -> Result<bool>
[src]
Gets the value of the IP_MULTICAST_LOOP
option for this socket.
This corresponds to async_std::net::UdpSocket::multicast_loop_v4
.
pub fn set_multicast_ttl_v4(&self, multicast_ttl_v4: u32) -> Result<()>
[src]
Sets the value of the IP_MULTICAST_TTL
option for this socket.
This corresponds to async_std::net::UdpSocket::set_multicast_ttl_v4
.
pub fn multicast_ttl_v4(&self) -> Result<u32>
[src]
Gets the value of the IP_MULTICAST_TTL
option for this socket.
This corresponds to async_std::net::UdpSocket::multicast_ttl_v4
.
pub fn set_multicast_loop_v6(&self, multicast_loop_v6: bool) -> Result<()>
[src]
Sets the value of the IPV6_MULTICAST_LOOP
option for this socket.
This corresponds to async_std::net::UdpSocket::set_multicast_loop_v6
.
pub fn multicast_loop_v6(&self) -> Result<bool>
[src]
Gets the value of the IPV6_MULTICAST_LOOP
option for this socket.
This corresponds to async_std::net::UdpSocket::multicast_loop_v6
.
pub fn set_ttl(&self, ttl: u32) -> Result<()>
[src]
Sets the value for the IP_TTL
option on this socket.
This corresponds to async_std::net::UdpSocket::set_ttl
.
pub fn ttl(&self) -> Result<u32>
[src]
Gets the value of the IP_TTL
option for this socket.
This corresponds to async_std::net::UdpSocket::ttl
.
pub fn join_multicast_v4(
&self,
multiaddr: Ipv4Addr,
interface: Ipv4Addr
) -> Result<()>
[src]
&self,
multiaddr: Ipv4Addr,
interface: Ipv4Addr
) -> Result<()>
Executes an operation of the IP_ADD_MEMBERSHIP
type.
This corresponds to async_std::net::UdpSocket::join_multicast_v4
.
pub fn join_multicast_v6(
&self,
multiaddr: &Ipv6Addr,
interface: u32
) -> Result<()>
[src]
&self,
multiaddr: &Ipv6Addr,
interface: u32
) -> Result<()>
Executes an operation of the IPV6_ADD_MEMBERSHIP
type.
This corresponds to async_std::net::UdpSocket::join_multicast_v6
.
pub fn leave_multicast_v4(
&self,
multiaddr: Ipv4Addr,
interface: Ipv4Addr
) -> Result<()>
[src]
&self,
multiaddr: Ipv4Addr,
interface: Ipv4Addr
) -> Result<()>
Executes an operation of the IP_DROP_MEMBERSHIP
type.
This corresponds to async_std::net::UdpSocket::leave_multicast_v4
.
pub fn leave_multicast_v6(
&self,
multiaddr: &Ipv6Addr,
interface: u32
) -> Result<()>
[src]
&self,
multiaddr: &Ipv6Addr,
interface: u32
) -> Result<()>
Executes an operation of the IPV6_DROP_MEMBERSHIP
type.
This corresponds to async_std::net::UdpSocket::leave_multicast_v6
.
pub async fn send(&self, buf: &[u8]) -> Result<usize>
[src]
Sends data on the socket to the remote address to which it is connected.
This corresponds to async_std::net::UdpSocket::send
.
pub async fn recv(&self, buf: &mut [u8]) -> Result<usize>
[src]
Receives a single datagram message on the socket from the remote address to which it is connected.
This corresponds to async_std::net::UdpSocket::recv
.
Trait Implementations
impl AsRawFd for UdpSocket
[src]
impl FromRawFd for UdpSocket
[src]
unsafe fn from_raw_fd(fd: RawFd) -> Self
[src]
impl IntoRawFd for UdpSocket
[src]
fn into_raw_fd(self) -> RawFd
[src]
impl OwnsRaw for UdpSocket
[src]
Safety: UdpSocket
wraps a net::UdpSocket
which owns its handle.
Auto Trait Implementations
impl RefUnwindSafe for UdpSocket
impl Send for UdpSocket
impl Sync for UdpSocket
impl Unpin for UdpSocket
impl UnwindSafe for UdpSocket
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> AsUnsafeFile for T where
T: OwnsRaw + AsRawFd,
[src]
T: OwnsRaw + AsRawFd,
pub fn as_unsafe_file(&self) -> UnsafeFile
[src]
pub fn as_file_view(&self) -> View<'_, File>
[src]
pub unsafe fn as_unscoped_file_view(&self) -> View<'static, File>
[src]
pub fn eq_file<Filelike>(&self, other: &Filelike) -> bool where
Filelike: AsUnsafeFile,
[src]
Filelike: AsUnsafeFile,
impl<T> AsUnsafeHandle for T where
T: OwnsRaw + AsRawFd,
[src]
T: OwnsRaw + AsRawFd,
pub fn as_unsafe_handle(&self) -> UnsafeHandle
[src]
pub fn eq_handle<Handlelike>(&self, other: &Handlelike) -> bool where
Handlelike: AsUnsafeHandle,
[src]
Handlelike: AsUnsafeHandle,
impl<T> AsUnsafeSocket for T where
T: OwnsRaw + AsRawFd,
[src]
T: OwnsRaw + AsRawFd,
pub fn as_unsafe_socket(&self) -> UnsafeSocket
[src]
pub fn as_tcp_stream_view(&self) -> View<'_, TcpStream>
[src]
pub unsafe fn as_unscoped_tcp_stream_view(&self) -> View<'static, TcpStream>
[src]
pub fn as_tcp_listener_view(&self) -> View<'_, TcpListener>
[src]
pub unsafe fn as_unscoped_tcp_listener_view(&self) -> View<'static, TcpListener>
[src]
pub fn as_udp_socket_view(&self) -> View<'_, UdpSocket>
[src]
pub unsafe fn as_unscoped_udp_socket_view(&self) -> View<'static, UdpSocket>
[src]
pub fn as_unix_stream_view(&self) -> View<'_, UnixStream>
[src]
pub unsafe fn as_unscoped_unix_stream_view(&self) -> View<'static, UnixStream>
[src]
pub fn eq_socket<Socketlike>(&self, other: &Socketlike) -> bool where
Socketlike: AsUnsafeSocket,
[src]
Socketlike: AsUnsafeSocket,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> FromUnsafeFile for T where
T: OwnsRaw + FromRawFd,
[src]
T: OwnsRaw + FromRawFd,
pub unsafe fn from_unsafe_file(unsafe_file: UnsafeFile) -> T
[src]
pub fn from_filelike<Filelike>(filelike: Filelike) -> Self where
Filelike: IntoUnsafeFile,
[src]
Filelike: IntoUnsafeFile,
impl<T> FromUnsafeSocket for T where
T: OwnsRaw + FromRawFd,
[src]
T: OwnsRaw + FromRawFd,
pub unsafe fn from_unsafe_socket(unsafe_socket: UnsafeSocket) -> T
[src]
pub fn from_socketlike<Socketlike>(socketlike: Socketlike) -> Self where
Socketlike: IntoUnsafeSocket,
[src]
Socketlike: IntoUnsafeSocket,
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> IntoUnsafeFile for T where
T: OwnsRaw + IntoRawFd,
[src]
T: OwnsRaw + IntoRawFd,
pub fn into_unsafe_file(self) -> UnsafeFile
[src]
impl<T> IntoUnsafeHandle for T where
T: OwnsRaw + IntoRawFd,
[src]
T: OwnsRaw + IntoRawFd,
pub fn into_unsafe_handle(self) -> UnsafeHandle
[src]
impl<T> IntoUnsafeSocket for T where
T: OwnsRaw + IntoRawFd,
[src]
T: OwnsRaw + IntoRawFd,
pub fn into_unsafe_socket(self) -> UnsafeSocket
[src]
impl<T> SetTimes for T where
T: AsUnsafeFile,
T: AsUnsafeFile,
pub fn set_times(
&self,
atime: Option<SystemTimeSpec>,
mtime: Option<SystemTimeSpec>
) -> Result<(), Error>
&self,
atime: Option<SystemTimeSpec>,
mtime: Option<SystemTimeSpec>
) -> Result<(), Error>
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>,