actix / book

Actix user guides

DEPRECATED: This repo has been deprecated, the new website is live on https://actix.rs/docs/actix/ and any updates will happen on https://github.com/actix/actix-website.

User guides

• Actix User Guide

• Actix API Documentation (Development)

• Actix API Documentation (Releases)

• Actix Web User Guide

• Actix Web API Documentation (Development)

• Actix Web API Documentation (Releases)

• Chat on gitter

Using this library

This repository is an mdBook project. To use it for this project:

• Install mdBook if you haven't already: cargo install mdbook
• In the actix directory: mdbook watch -o
  • This automatically opens your browser and watches the md files for changing
  • You'll still have to refresh the page, as there is no hot-reloading for mdbook

book's Issues

File name and path is not mentionned

I’d love to see where to put the code of actors in https://github.com/actix/book/blob/master/actix/src/sec-1-getting-started.md

Update to 0.9/0.10-alpha

The current book is written with actix 0.7, it's quite old. We should rewrite this book with actix 0.9/0.10-alpha.

Example does not build

The example listed in https://actix.rs/book/actix/sec-2-actor.html#complete-example does not build for me. I saw two problems:

• I had to update the Cargo.toml file to include a dependency on the futures crate.

• I see the following compiler error after adding the dependency on the futures crate:

  Compiling actor-ping v0.1.0 (/home/akhi/projects/actor-ping)
warning: unused import: `futures::Future`
 --> src/main.rs:2:5
  |
2 | use futures::Future;
  |     ^^^^^^^^^^^^^^^
  |
  = note: `#[warn(unused_imports)]` on by default

error[E0599]: no method named `map` found for type `actix::address::message::Request<MyActor, Ping>` in the current scope
  --> src/main.rs:52:14
   |
52 |             .map(|res| match res {
   |              ^^^ method not found in `actix::address::message::Request<MyActor, Ping>`
   |
   = note: the method `map` exists but the following trait bounds were not satisfied:
           `&mut actix::address::message::Request<MyActor, Ping> : futures::stream::Stream`
           `&mut actix::address::message::Request<MyActor, Ping> : std::iter::Iterator`
   = help: items from traits can only be used if the trait is in scope
help: the following trait is implemented but not in scope; perhaps add a `use` for it:
   |
1  | use futures::future::Future;
   |

error: aborting due to previous error

For more information about this error, try `rustc --explain E0599`.
error: could not compile `actor-ping`.

To learn more, run the command again with --verbose.

The version I am using is:

$ cargo --version
cargo 1.41.0

Example from the Arbiter chapter fails to compile

The example in arbiter chapter does not compile.

I'm compiling on rust nightly rustc 1.43.0-nightly (8aa9d2014 2020-02-21)

warning: unused import: `futures::Future`
 --> src/main.rs:4:5
  |
4 | use futures::Future;
  |     ^^^^^^^^^^^^^^^
  |
  = note: `#[warn(unused_imports)]` on by default

error[E0599]: no method named `map_err` found for struct `actix::prelude::Request<SumActor, Value>` in the current scope
  --> src/main.rs:63:10
   |
63 |         .map_err(|e| {
   |          ^^^^^^^ method not found in `actix::prelude::Request<SumActor, Value>`
   |
   = help: items from traits can only be used if the trait is in scope
help: the following trait is implemented but not in scope; perhaps add a `use` for it:
   |
3  | use crate::futures::TryFutureExt;
   |

error[E0599]: no method named `map` found for struct `actix::prelude::Request<DisplayActor, Display>` in the current scope
  --> src/main.rs:74:41
   |
74 |             dis_addr.send(Display(res)).map(move |_| ()).map_err(|_| ())
   |                                         ^^^ method not found in `actix::prelude::Request<DisplayActor, Display>`
   |
   = note: the method `map` exists but the following trait bounds were not satisfied:
           `&mut actix::prelude::Request<DisplayActor, Display> : std::iter::Iterator`
   = help: items from traits can only be used if the trait is in scope
help: the following trait is implemented but not in scope; perhaps add a `use` for it:
   |
3  | use crate::futures::FutureExt;
   |

error: aborting due to 2 previous errors

For more information about this error, try `rustc --explain E0599`.
error: could not compile `actix-middleware-tryout`.

To learn more, run the command again with --verbose.

Tried adding suggested use statements, but no luck.

warning: unused import: `futures::Future`
 --> src/main.rs:4:5
  |
4 | use futures::Future;
  |     ^^^^^^^^^^^^^^^
  |
  = note: `#[warn(unused_imports)]` on by default

error[E0599]: no method named `map_err` found for struct `futures::future::Map<actix::prelude::Request<DisplayActor, Display>, [closure@src/main.rs:76:45: 76:56]>` in the current scope
  --> src/main.rs:76:58
   |
76 |             dis_addr.send(Display(res)).map(move |_| ()).map_err(|_| ())
   |                                                          ^^^^^^^ method not found in `futures::future::Map<actix::prelude::Request<DisplayActor, Display>, [closure@src/main.rs:76:45: 76:56]>`
   |
   = note: the method `map_err` exists but the following trait bounds were not satisfied:
           `&futures::future::Map<actix::prelude::Request<DisplayActor, Display>, [closure@src/main.rs:76:45: 76:56]> : futures::TryFutureExt`
           `&mut futures::future::Map<actix::prelude::Request<DisplayActor, Display>, [closure@src/main.rs:76:45: 76:56]> : futures::TryFutureExt`
           `futures::future::Map<actix::prelude::Request<DisplayActor, Display>, [closure@src/main.rs:76:45: 76:56]> : futures::TryFutureExt`

error: aborting due to previous error

For more information about this error, try `rustc --explain E0599`.
error: could not compile `actix-middleware-tryout`.

To learn more, run the command again with --verbose.

Would love to see the supervisor and registry in the user guide.

Hello!

We love actix actor framework and we've been using it in our production development for an year now. We've been using the registry functionality in our code, and mostly been reading the API documentation and the code to figure out how to use the features, but it would be really nice if these features were explained by the developers in the user guide.

Would love to see the context page

Please don't stop just when it was getting interesting! Really like the guild - hope you find a little time to push it forwards a little. - thankyou!

Update the actix version to 0.11

Split actix and actix-web guides

Let’s still use same repo, but I think we should split guides

All link to the doc in the book are broken

For example: https://actix.rs/book/actix

• https://actix.rs/book/actix/trait.Actor.html
• https://actix.rs/book/actix/trait.Handler.html
• https://actix.rs/book/actix/trait.Message.html

etc...

Addresses typo

Here it shows to exactly the same code snippets saying

Same example, but returned address is thread safe and can be sent to different thread.

which is probably wrong.

Home page does not exist

The home page listed (actix.rs/book) does not appear to exist. It returns a Page Not Found message.

Replace/Update `Errors` example from `failure` to `thiserror`/`anyhow`

Hi,

The failure crate is deprecated. We should try to update our examples to thiserror/anyhow since they are now considered more "idiomatic."

I'd be willing to do the legwork, but I need to have someone validate the example I would write.

Thanks.