actix-web/MIGRATION.md

1.0

• Resource registration. 1.0 version uses generalized resource registration via .service() method.

  instead of

    App.new().resource("/welcome", |r| r.f(welcome))
  

  use App's or Scope's .service() method. .service() method accepts object that implements HttpServiceFactory trait. By default actix-web provides Resource and Scope services.

    App.new().service(
        web::resource("/welcome")
            .route(web::get().to(welcome))
            .route(web::post().to(post_handler))
  

• Scope registration.

  instead of

      let app = App::new().scope("/{project_id}", |scope| {
            scope
                .resource("/path1", |r| r.f(|_| HttpResponse::Ok()))
                .resource("/path2", |r| r.f(|_| HttpResponse::Ok()))
                .resource("/path3", |r| r.f(|_| HttpResponse::MethodNotAllowed()))
      });
  

  use .service() for registration and web::scope() as scope object factory.

      let app = App::new().service(
          web::scope("/{project_id}")
              .service(web::resource("/path1").to(|| HttpResponse::Ok()))
              .service(web::resource("/path2").to(|| HttpResponse::Ok()))
              .service(web::resource("/path3").to(|| HttpResponse::MethodNotAllowed()))
      );
  

• .f(), .a() and .h() handler registration methods have been removed. Use .to() for handlers and .to_async() for async handlers. Handler function must use extractors.

  instead of

    App.new().resource("/welcome", |r| r.f(welcome))
  

  use App's to() or to_async() methods

    App.new().service(web::resource("/welcome").to(welcome))
  

• State is now Data. You register Data during the App initialization process and then access it from handlers either using a Data extractor or using HttpRequest's api.

  instead of

    App.with_state(T)
  

  use App's data method

    App.new()
       .data(T)
  

  and either use the Data extractor within your handler

    use actix_web::web::Data;
  
    fn endpoint_handler(Data<T>)){
      ...
    }
  

  .. or access your Data element from the HttpRequest

    fn endpoint_handler(req: HttpRequest) {
    	let data: Option<Data<T>> = req.app_data::<T>();
    }
  

• AsyncResponder is removed.

  instead of

    use actix_web::AsyncResponder;
  
    fn endpoint_handler(...) -> impl Future<Item=HttpResponse, Error=Error>{
    	...
        .responder()
    }
  

  .. simply omit AsyncResponder and the corresponding responder() finish method

• Middleware

  instead of

      let app = App::new()
           .middleware(middleware::Logger::default())
  

  use .wrap() method

      let app = App::new()
           .wrap(middleware::Logger::default())
           .route("/index.html", web::get().to(index));
  

• HttpRequest::body(), HttpRequest::urlencoded(), HttpRequest::json(), HttpRequest::multipart() method have been removed. Use Bytes, String, Form, Json, Multipart extractors instead.

  instead if

  fn index(req: &HttpRequest) -> Responder {
     req.body()
       .and_then(|body| {
          ...
       })
  }
  
  use
  
  ```rust
  fn index(body: Bytes) -> Responder {
     ...
  }
  

• StaticFiles and NamedFile has been move to separate create.

  instead of use actix_web::fs::StaticFile

  use use actix_files::Files

  instead of use actix_web::fs::Namedfile

  use use actix_files::NamedFile

• Multipart has been move to separate create.

  instead of use actix_web::multipart::Multipart

  use use actix_multipart::Multipart

• Request/response compression/decompression is not enabled by default. To enable use App::enable_encoding() method.

• actix_web::server module has been removed. To start http server use actix_web::HttpServer type

• Actors support have been moved to actix-web-actors crate

0.7.15

• The ' ' character is not percent decoded anymore before matching routes. If you need to use it in your routes, you should use %20.

  instead of

  fn main() {
       let app = App::new().resource("/my index", |r| {
           r.method(http::Method::GET)
                  .with(index);
       });
  }
  

  use

  fn main() {
       let app = App::new().resource("/my%20index", |r| {
           r.method(http::Method::GET)
                  .with(index);
       });
  }
  

• If you used AsyncResult::async you need to replace it with AsyncResult::future

0.7.4

• Route::with_config()/Route::with_async_config() always passes configuration objects as tuple even for handler with one parameter.

0.7

• HttpRequest does not implement Stream anymore. If you need to read request payload use HttpMessage::payload() method.

  instead of

  fn index(req: HttpRequest) -> impl Responder {
       req
          .from_err()
          .fold(...)
          ....
  }
  

  use .payload()

  fn index(req: HttpRequest) -> impl Responder {
       req
          .payload()  // <- get request payload stream
          .from_err()
          .fold(...)
          ....
  }
  

• Middleware trait uses &HttpRequest instead of &mut HttpRequest.

• Removed Route::with2() and Route::with3() use tuple of extractors instead.

  instead of

  fn index(query: Query<..>, info: Json<MyStruct) -> impl Responder {}
  

  use tuple of extractors and use .with() for registration:

  fn index((query, json): (Query<..>, Json<MyStruct)) -> impl Responder {}
  

• Handler::handle() uses &self instead of &mut self

• Handler::handle() accepts reference to HttpRequest<_> instead of value

• Removed deprecated HttpServer::threads(), use HttpServer::workers() instead.

• Renamed client::ClientConnectorError::Connector to client::ClientConnectorError::Resolver

• Route::with() does not return ExtractorConfig, to configure extractor use Route::with_config()

  instead of

  fn main() {
       let app = App::new().resource("/index.html", |r| {
           r.method(http::Method::GET)
                  .with(index)
                  .limit(4096);  // <- limit size of the payload
       });
  }
  

  use

  
  fn main() {
       let app = App::new().resource("/index.html", |r| {
           r.method(http::Method::GET)
                  .with_config(index, |cfg| { // <- register handler
                     cfg.limit(4096);  // <- limit size of the payload
                   })
       });
  }
  

• Route::with_async() does not return ExtractorConfig, to configure extractor use Route::with_async_config()

0.6

• Path<T> extractor return ErrorNotFound on failure instead of ErrorBadRequest

• ws::Message::Close now includes optional close reason. ws::CloseCode::Status and ws::CloseCode::Empty have been removed.

• HttpServer::threads() renamed to HttpServer::workers().

• HttpServer::start_ssl() and HttpServer::start_tls() deprecated. Use HttpServer::bind_ssl() and HttpServer::bind_tls() instead.

• HttpRequest::extensions() returns read only reference to the request's Extension HttpRequest::extensions_mut() returns mutable reference.

• Instead of

  use actix_web::middleware::{ CookieSessionBackend, CookieSessionError, RequestSession, Session, SessionBackend, SessionImpl, SessionStorage};

  use actix_web::middleware::session

  use actix_web::middleware::session{CookieSessionBackend, CookieSessionError, RequestSession, Session, SessionBackend, SessionImpl, SessionStorage};

• FromRequest::from_request() accepts mutable reference to a request

• FromRequest::Result has to implement Into<Reply<Self>>

• Responder::respond_to() is generic over S

• Use Query extractor instead of HttpRequest::query()`.

  fn index(q: Query<HashMap<String, String>>) -> Result<..> {
      ...
  }
  

  or

  let q = Query::<HashMap<String, String>>::extract(req);
  

• Websocket operations are implemented as WsWriter trait. you need to use use actix_web::ws::WsWriter

0.5

• HttpResponseBuilder::body(), .finish(), .json() methods return HttpResponse instead of Result<HttpResponse>

• actix_web::Method, actix_web::StatusCode, actix_web::Version moved to actix_web::http module

• actix_web::header moved to actix_web::http::header

• NormalizePath moved to actix_web::http module

• HttpServer moved to actix_web::server, added new actix_web::server::new() function, shortcut for actix_web::server::HttpServer::new()

• DefaultHeaders middleware does not use separate builder, all builder methods moved to type itself

• StaticFiles::new()'s show_index parameter removed, use show_files_listing() method instead.

• CookieSessionBackendBuilder removed, all methods moved to CookieSessionBackend type

• actix_web::httpcodes module is deprecated, HttpResponse::Ok(), HttpResponse::Found() and other HttpResponse::XXX() functions should be used instead

• ClientRequestBuilder::body() returns Result<_, actix_web::Error> instead of Result<_, http::Error>

• Application renamed to a App

• actix_web::Reply, actix_web::Resource moved to actix_web::dev