async-datagram 1.0.0

#![forbid(unsafe_code, future_incompatible)]
#![deny(missing_debug_implementations, bad_style)]
#![deny(missing_docs)]
#![cfg_attr(test, deny(warnings))]

//! Async datagram traits.
//!
//! ## Example
//!
//! ```rust
//! #![feature(futures_api)]
//!
//! use async_datagram::AsyncDatagram;
//! use std::task::{Waker, Poll};
//!
//! struct Udp;
//!
//! impl AsyncDatagram for Udp {
//!   type Target = std::net::SocketAddr;
//!   type Err = std::io::Error;
//!
//!   fn poll_send_to(
//!     &mut self,
//!     waker: &Waker,
//!     buf: &[u8],
//!     target: impl AsRef<Self::Target>,
//!   ) -> Poll<Result<usize, Self::Err>> {
//!     Poll::Ready(Ok(0))
//!   }
//!
//!   fn poll_recv_from(
//!     &mut self,
//!     waker: &Waker,
//!     buf: &mut [u8],
//!   ) -> Poll<Result<(usize, Self::Target), Self::Err>> {
//!     Poll::Pending
//!   }
//! }
//! ```

#![feature(futures_api)]

use std::task::{Poll, Waker};

/// Implement a datagram protocol.
pub trait AsyncDatagram {
  /// Specifies which target to send the data to.
  type Target;

  /// The type of failures yielded by this trait.
  type Err;

  /// Sends data on the IO interface to the specified target.
  ///
  /// On success, returns the number of bytes written.
  fn poll_send_to(
    &mut self,
    waker: &Waker,
    buf: &[u8],
    target: impl AsRef<Self::Target>,
  ) -> Poll<Result<usize, Self::Err>>;

  /// Receives data from the IO interface.
  ///
  /// On success, returns the number of bytes read and the target from whence
  /// the data came.
  fn poll_recv_from(
    &mut self,
    waker: &Waker,
    buf: &mut [u8],
  ) -> Poll<Result<(usize, Self::Target), Self::Err>>;
}