1
0
mirror of https://github.com/fafhrd91/actix-net synced 2024-11-27 19:12:56 +01:00

added docs for trait Service, trait Transform

This commit is contained in:
dowwie 2019-04-04 11:40:28 -04:00
parent 629ed05f82
commit 33cd51aabf
2 changed files with 15 additions and 3 deletions

View File

@ -53,6 +53,9 @@ pub use self::then::{Then, ThenNewService};
pub use self::transform::{apply_transform, IntoTransform, Transform};
/// An asynchronous function from `Request` to a `Response`.
/// The entire request/response lifecycle can be represented as a pipeline of
/// Services. The linkage between Services is represented in terms of ownership,
/// where the preceeding Service owns that which follows it.
pub trait Service {
/// Requests handled by the service.
type Request;

View File

@ -6,9 +6,16 @@ use futures::{Async, Future, IntoFuture, Poll};
use crate::transform_err::{TransformFromErr, TransformMapInitErr};
use crate::{IntoNewService, NewService, Service};
/// `Transform` service factory.
/// The `Transform` trait defines the interface of a Service factory. `Transform`
/// is often implemented for middleware, defining how to manufacture a
/// middleware Service. A Service that is manufactured by the factory takes
/// the Service that follows it during execution as a parameter, assuming
/// ownership of the next Service. A Service can be a variety of types, such
/// as (but not limited to) another middleware Service, an extractor Service,
/// other helper Services, or the request handler endpoint Service.
///
/// A Service is created by the factory during server initialization.
///
/// Transform factory creates service that wraps other services.
/// `Config` is a service factory configuration type.
pub trait Transform<S> {
/// Requests handled by the service.
@ -33,7 +40,9 @@ pub trait Transform<S> {
/// The future response value.
type Future: Future<Item = Self::Transform, Error = Self::InitError>;
/// Create and return a new service value asynchronously.
/// Creates and returns a new Service component, asynchronously. `new_transform`
/// is called only once during the lifetime of a server -- as the server
/// initializes.
fn new_transform(&self, service: S) -> Self::Future;
/// Map this service's factory error to a different error,