1
0
mirror of https://github.com/fafhrd91/actix-net synced 2024-11-24 01:11:07 +01:00

Intradoc links conversion (#227)

* intra doc conversion

* rm trailing blank comment
This commit is contained in:
Aravinth Manivannan 2020-12-14 13:52:30 +05:30 committed by GitHub
parent 02a902068f
commit b296d0f254
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 7 additions and 13 deletions

View File

@ -4,8 +4,6 @@
//! [`AsyncWrite`], to framed streams implementing [`Sink`] and [`Stream`]. //! [`AsyncWrite`], to framed streams implementing [`Sink`] and [`Stream`].
//! Framed streams are also known as `transports`. //! Framed streams are also known as `transports`.
//! //!
//! [`AsyncRead`]: AsyncRead
//! [`AsyncWrite`]: AsyncWrite
//! [`Sink`]: futures_sink::Sink //! [`Sink`]: futures_sink::Sink
//! [`Stream`]: futures_core::Stream //! [`Stream`]: futures_core::Stream

View File

@ -138,7 +138,7 @@ impl<T: Address> fmt::Display for Connect<T> {
} }
} }
/// Iterator over addresses in a [`Connect`](struct.Connect.html) request. /// Iterator over addresses in a [`Connect`] request.
#[derive(Clone)] #[derive(Clone)]
pub struct ConnectAddrsIter<'a> { pub struct ConnectAddrsIter<'a> {
inner: Either<Option<SocketAddr>, vec_deque::Iter<'a, SocketAddr>>, inner: Either<Option<SocketAddr>, vec_deque::Iter<'a, SocketAddr>>,
@ -173,7 +173,7 @@ impl ExactSizeIterator for ConnectAddrsIter<'_> {}
impl FusedIterator for ConnectAddrsIter<'_> {} impl FusedIterator for ConnectAddrsIter<'_> {}
/// Owned iterator over addresses in a [`Connect`](struct.Connect.html) request. /// Owned iterator over addresses in a [`Connect`] request.
#[derive(Debug)] #[derive(Debug)]
pub struct ConnectTakeAddrsIter { pub struct ConnectTakeAddrsIter {
inner: Either<Option<SocketAddr>, vec_deque::IntoIter<SocketAddr>>, inner: Either<Option<SocketAddr>, vec_deque::IntoIter<SocketAddr>>,

View File

@ -7,7 +7,7 @@ use tokio::{runtime, task::LocalSet};
/// ///
/// See [module level][mod] documentation for more details. /// See [module level][mod] documentation for more details.
/// ///
/// [mod]: index.html /// [mod]: crate
#[derive(Debug)] #[derive(Debug)]
pub struct Runtime { pub struct Runtime {
local: LocalSet, local: LocalSet,
@ -34,7 +34,7 @@ impl Runtime {
/// ///
/// See [module level][mod] documentation for more details. /// See [module level][mod] documentation for more details.
/// ///
/// [mod]: index.html /// [mod]: crate
/// ///
/// # Examples /// # Examples
/// ///

View File

@ -66,7 +66,6 @@ impl System {
/// It means that using this method currently it is impossible to make `actix-rt` work in the /// It means that using this method currently it is impossible to make `actix-rt` work in the
/// alternative `tokio` `Runtime`s (e.g. provided by [`tokio_compat`]). /// alternative `tokio` `Runtime`s (e.g. provided by [`tokio_compat`]).
/// ///
/// [`Arbiter`]: struct.Arbiter.html
/// [`tokio_compat`]: https://crates.io/crates/tokio-compat /// [`tokio_compat`]: https://crates.io/crates/tokio-compat
/// ///
/// # Examples /// # Examples
@ -131,7 +130,6 @@ impl System {
/// It means that using this method currently it is impossible to make `actix-rt` work in the /// It means that using this method currently it is impossible to make `actix-rt` work in the
/// alternative `tokio` `Runtime`s (e.g. provided by `tokio_compat`). /// alternative `tokio` `Runtime`s (e.g. provided by `tokio_compat`).
/// ///
/// [`Arbiter`]: struct.Arbiter.html
/// [`tokio_compat`]: https://crates.io/crates/tokio-compat /// [`tokio_compat`]: https://crates.io/crates/tokio-compat
/// ///
/// # Arguments /// # Arguments

View File

@ -1,4 +1,4 @@
//! See [`Service`](trait.Service.html) docs for information on this crate's foundational trait. //! See [`Service`] docs for information on this crate's foundational trait.
#![deny(rust_2018_idioms, nonstandard_style)] #![deny(rust_2018_idioms, nonstandard_style)]
#![allow(clippy::type_complexity)] #![allow(clippy::type_complexity)]
@ -67,7 +67,7 @@ pub use self::transform::{apply, Transform};
/// ``` /// ```
/// ///
/// Sometimes it is not necessary to implement the Service trait. For example, the above service /// Sometimes it is not necessary to implement the Service trait. For example, the above service
/// could be rewritten as a simple function and passed to [fn_service](fn.fn_service.html). /// could be rewritten as a simple function and passed to [fn_service](fn_service()).
/// ///
/// ```rust,ignore /// ```rust,ignore
/// async fn my_service(req: u8) -> Result<u64, MyError>; /// async fn my_service(req: u8) -> Result<u64, MyError>;

View File

@ -60,8 +60,6 @@ where
} }
/// A `Transform` implementation that wraps services with a [`TracingService`]. /// A `Transform` implementation that wraps services with a [`TracingService`].
///
/// [`TracingService`]: struct.TracingService.html
pub struct TracingTransform<S, U, F> { pub struct TracingTransform<S, U, F> {
make_span: F, make_span: F,
_p: PhantomData<fn(S, U)>, _p: PhantomData<fn(S, U)>,

View File

@ -11,7 +11,7 @@ use bytes::Bytes;
/// A UTF-8 encoded string with [`Bytes`] as a storage. /// A UTF-8 encoded string with [`Bytes`] as a storage.
/// ///
/// [`Bytes`]: https://docs.rs/bytes/0.5.3/bytes/struct.Bytes.html /// [`Bytes`]: bytes::Bytes
#[derive(Clone, Eq, Ord, PartialOrd, Default)] #[derive(Clone, Eq, Ord, PartialOrd, Default)]
pub struct ByteString(Bytes); pub struct ByteString(Bytes);