Struct cap_async_std::net::UdpSocket
source · [−]pub struct UdpSocket { /* private fields */ }Expand description
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 Pool permitting the address, and then
call Pool::bind_udp_socket, or Pool::connect_udp_socket, or
Pool::send_to_udp_socket_addr.
Implementations
sourceimpl UdpSocket
impl UdpSocket
sourcepub fn from_std(std: UdpSocket) -> Self
pub fn from_std(std: UdpSocket) -> Self
Constructs a new instance of Self from the given
async_std::net::UdpSocket.
This grants access the resources the async_std::net::UdpSocket
instance already has access to.
sourcepub async fn recv_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr)>
pub async fn recv_from(&self, buf: &mut [u8]) -> Result<(usize, SocketAddr)>
Receives a single datagram message on the socket.
This corresponds to async_std::net::UdpSocket::recv_from.
sourcepub fn peer_addr(&self) -> Result<SocketAddr>
pub fn peer_addr(&self) -> Result<SocketAddr>
Returns the socket address of the remote peer this socket was connected to.
This corresponds to async_std::net::UdpSocket::peer_addr.
sourcepub fn local_addr(&self) -> Result<SocketAddr>
pub fn local_addr(&self) -> Result<SocketAddr>
Returns the socket address that this socket was created from.
This corresponds to async_std::net::UdpSocket::local_addr.
sourcepub fn set_broadcast(&self, broadcast: bool) -> Result<()>
pub fn set_broadcast(&self, broadcast: bool) -> Result<()>
Sets the value of the SO_BROADCAST option for this socket.
This corresponds to async_std::net::UdpSocket::set_broadcast.
sourcepub fn broadcast(&self) -> Result<bool>
pub fn broadcast(&self) -> Result<bool>
Gets the value of the SO_BROADCAST option for this socket.
This corresponds to async_std::net::UdpSocket::broadcast.
sourcepub fn set_multicast_loop_v4(&self, multicast_loop_v4: bool) -> Result<()>
pub fn set_multicast_loop_v4(&self, multicast_loop_v4: bool) -> Result<()>
Sets the value of the IP_MULTICAST_LOOP option for this socket.
This corresponds to
async_std::net::UdpSocket::set_multicast_loop_v4.
sourcepub fn multicast_loop_v4(&self) -> Result<bool>
pub fn multicast_loop_v4(&self) -> Result<bool>
Gets the value of the IP_MULTICAST_LOOP option for this socket.
This corresponds to async_std::net::UdpSocket::multicast_loop_v4.
sourcepub fn set_multicast_ttl_v4(&self, multicast_ttl_v4: u32) -> Result<()>
pub fn set_multicast_ttl_v4(&self, multicast_ttl_v4: u32) -> Result<()>
Sets the value of the IP_MULTICAST_TTL option for this socket.
This corresponds to
async_std::net::UdpSocket::set_multicast_ttl_v4.
sourcepub fn multicast_ttl_v4(&self) -> Result<u32>
pub fn multicast_ttl_v4(&self) -> Result<u32>
Gets the value of the IP_MULTICAST_TTL option for this socket.
This corresponds to async_std::net::UdpSocket::multicast_ttl_v4.
sourcepub fn set_multicast_loop_v6(&self, multicast_loop_v6: bool) -> Result<()>
pub fn set_multicast_loop_v6(&self, multicast_loop_v6: bool) -> Result<()>
Sets the value of the IPV6_MULTICAST_LOOP option for this socket.
This corresponds to
async_std::net::UdpSocket::set_multicast_loop_v6.
sourcepub fn multicast_loop_v6(&self) -> Result<bool>
pub fn multicast_loop_v6(&self) -> Result<bool>
Gets the value of the IPV6_MULTICAST_LOOP option for this socket.
This corresponds to async_std::net::UdpSocket::multicast_loop_v6.
sourcepub fn set_ttl(&self, ttl: u32) -> Result<()>
pub fn set_ttl(&self, ttl: u32) -> Result<()>
Sets the value for the IP_TTL option on this socket.
This corresponds to async_std::net::UdpSocket::set_ttl.
sourcepub fn ttl(&self) -> Result<u32>
pub fn ttl(&self) -> Result<u32>
Gets the value of the IP_TTL option for this socket.
This corresponds to async_std::net::UdpSocket::ttl.
sourcepub fn join_multicast_v4(
&self,
multiaddr: Ipv4Addr,
interface: Ipv4Addr
) -> Result<()>
pub fn join_multicast_v4(
&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.
sourcepub fn join_multicast_v6(
&self,
multiaddr: &Ipv6Addr,
interface: u32
) -> Result<()>
pub fn join_multicast_v6(
&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.
sourcepub fn leave_multicast_v4(
&self,
multiaddr: Ipv4Addr,
interface: Ipv4Addr
) -> Result<()>
pub fn leave_multicast_v4(
&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.
sourcepub fn leave_multicast_v6(
&self,
multiaddr: &Ipv6Addr,
interface: u32
) -> Result<()>
pub fn leave_multicast_v6(
&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.
Trait Implementations
sourceimpl AsFd for UdpSocket
impl AsFd for UdpSocket
sourcefn as_fd(&self) -> BorrowedFd<'_>
fn as_fd(&self) -> BorrowedFd<'_>
Borrows the file descriptor. Read more
sourceimpl FromRawFd for UdpSocket
impl FromRawFd for UdpSocket
sourceunsafe fn from_raw_fd(fd: RawFd) -> Self
unsafe fn from_raw_fd(fd: RawFd) -> Self
Constructs a new instance of Self from the given raw file
descriptor. Read more
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
sourceimpl<T> AsFilelike for T where
T: AsFd,
impl<T> AsFilelike for T where
T: AsFd,
sourcepub fn as_filelike(&self) -> BorrowedFd<'_>
pub fn as_filelike(&self) -> BorrowedFd<'_>
Borrows the reference. Read more
sourcepub fn as_filelike_view<Target>(&self) -> FilelikeView<'_, Target> where
Target: FromFilelike + IntoFilelike,
pub fn as_filelike_view<Target>(&self) -> FilelikeView<'_, Target> where
Target: FromFilelike + IntoFilelike,
Return a borrowing view of a resource which dereferences to a &Target
or &mut Target. Read more
sourceimpl<T> AsGrip for T where
T: AsFd,
impl<T> AsGrip for T where
T: AsFd,
sourcepub fn as_grip(&self) -> BorrowedFd<'_>
pub fn as_grip(&self) -> BorrowedFd<'_>
Extracts the grip.
sourceimpl<T> AsRawFilelike for T where
T: AsRawFd,
impl<T> AsRawFilelike for T where
T: AsRawFd,
sourcepub fn as_raw_filelike(&self) -> i32
pub fn as_raw_filelike(&self) -> i32
Returns the raw value.
sourceimpl<T> AsRawGrip for T where
T: AsRawFd,
impl<T> AsRawGrip for T where
T: AsRawFd,
sourcepub fn as_raw_grip(&self) -> i32
pub fn as_raw_grip(&self) -> i32
Extracts the raw grip.
sourceimpl<T> AsRawSocketlike for T where
T: AsRawFd,
impl<T> AsRawSocketlike for T where
T: AsRawFd,
sourcepub fn as_raw_socketlike(&self) -> i32
pub fn as_raw_socketlike(&self) -> i32
Returns the raw value.
sourceimpl<T> AsSocketlike for T where
T: AsFd,
impl<T> AsSocketlike for T where
T: AsFd,
sourcepub fn as_socketlike(&self) -> BorrowedFd<'_>
pub fn as_socketlike(&self) -> BorrowedFd<'_>
Borrows the reference.
sourcepub fn as_socketlike_view<Target>(&self) -> FilelikeView<'_, Target> where
Target: FromSocketlike + IntoSocketlike,
pub fn as_socketlike_view<Target>(&self) -> FilelikeView<'_, Target> where
Target: FromSocketlike + IntoSocketlike,
Return a borrowing view of a resource which dereferences to a &Target
or &mut Target. Read more
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> FromFilelike for T where
T: FromFd,
impl<T> FromFilelike for T where
T: FromFd,
sourcepub fn from_filelike(owned: OwnedFd) -> T
pub fn from_filelike(owned: OwnedFd) -> T
Constructs a new instance of Self from the given filelike object. Read more
sourcepub fn from_into_filelike<Owned>(owned: Owned) -> T where
Owned: IntoFilelike,
pub fn from_into_filelike<Owned>(owned: Owned) -> T where
Owned: IntoFilelike,
Constructs a new instance of Self from the given filelike object
converted from into_owned. Read more
sourceimpl<T> FromRawFilelike for T where
T: FromRawFd,
impl<T> FromRawFilelike for T where
T: FromRawFd,
sourcepub unsafe fn from_raw_filelike(raw: i32) -> T
pub unsafe fn from_raw_filelike(raw: i32) -> T
Constructs Self from the raw value. Read more
sourceimpl<T> FromRawGrip for T where
T: FromRawFd,
impl<T> FromRawGrip for T where
T: FromRawFd,
sourcepub unsafe fn from_raw_grip(raw_grip: i32) -> T
pub unsafe fn from_raw_grip(raw_grip: i32) -> T
Consume an RawGrip and convert into a Self. Read more
sourceimpl<T> FromRawSocketlike for T where
T: FromRawFd,
impl<T> FromRawSocketlike for T where
T: FromRawFd,
sourcepub unsafe fn from_raw_socketlike(raw: i32) -> T
pub unsafe fn from_raw_socketlike(raw: i32) -> T
Constructs Self from the raw value. Read more
sourceimpl<T> FromSocketlike for T where
T: FromFd,
impl<T> FromSocketlike for T where
T: FromFd,
sourcepub fn from_socketlike(owned: OwnedFd) -> T
pub fn from_socketlike(owned: OwnedFd) -> T
Constructs a new instance of Self from the given socketlike object.
sourcepub fn from_into_socketlike<Owned>(owned: Owned) -> T where
Owned: IntoSocketlike,
pub fn from_into_socketlike<Owned>(owned: Owned) -> T where
Owned: IntoSocketlike,
Constructs a new instance of Self from the given socketlike object
converted from into_owned. Read more
sourceimpl<T> IntoFilelike for T where
T: IntoFd,
impl<T> IntoFilelike for T where
T: IntoFd,
sourcepub fn into_filelike(self) -> OwnedFd
pub fn into_filelike(self) -> OwnedFd
Consumes this object, returning the underlying filelike object. Read more
sourceimpl<T> IntoRawFilelike for T where
T: IntoRawFd,
impl<T> IntoRawFilelike for T where
T: IntoRawFd,
sourcepub fn into_raw_filelike(self) -> i32
pub fn into_raw_filelike(self) -> i32
Returns the raw value.
sourceimpl<T> IntoRawGrip for T where
T: IntoRawFd,
impl<T> IntoRawGrip for T where
T: IntoRawFd,
sourcepub fn into_raw_grip(self) -> i32
pub fn into_raw_grip(self) -> i32
Consume self and convert into an RawGrip.
sourceimpl<T> IntoSocketlike for T where
T: IntoFd,
impl<T> IntoSocketlike for T where
T: IntoFd,
sourcepub fn into_socketlike(self) -> OwnedFd
pub fn into_socketlike(self) -> OwnedFd
Consumes this object, returning the underlying socketlike object.