|
1 | 1 | //! # Restate Rust SDK |
2 | 2 | //! |
3 | | -//! [Restate](https://restate.dev/) is a system for easily building resilient applications using _distributed durable async/await_. |
| 3 | +//! [Restate](https://restate.dev/) is a system for easily building resilient applications. |
4 | 4 | //! This crate is the Restate SDK for writing Restate services using Rust. |
5 | 5 | //! |
| 6 | +//! ## New to Restate? |
| 7 | +//! |
| 8 | +//! If you are new to Restate, we recommend the following resources: |
| 9 | +//! |
| 10 | +//! - [Learn about the concepts of Restate](https://docs.restate.dev/concepts/durable_building_blocks) |
| 11 | +//! - Use cases: |
| 12 | +//! - [Workflows](https://docs.restate.dev/use-cases/workflows) |
| 13 | +//! - [Microservice orchestration](https://docs.restate.dev/use-cases/microservice-orchestration) |
| 14 | +//! - [Event processing](https://docs.restate.dev/use-cases/event-processing) |
| 15 | +//! - [Async tasks](https://docs.restate.dev/use-cases/async-tasks) |
| 16 | +//! - [Quickstart](https://docs.restate.dev/get_started/quickstart?sdk=rust) |
| 17 | +//! - [Do the Tour of Restate to try out the APIs](https://docs.restate.dev/get_started/tour/?sdk=rust) |
| 18 | +//! |
| 19 | +//! # SDK Overview |
| 20 | +//! |
| 21 | +//! The Restate Rust SDK lets you implement durable handlers. Handlers can be part of three types of services: |
| 22 | +//! |
| 23 | +//! Let's have a look at how to define them. |
| 24 | +//! |
6 | 25 | //! ```rust,no_run |
7 | 26 | //! // The prelude contains all the imports you need to get started |
8 | 27 | //! use restate_sdk::prelude::*; |
|
34 | 53 | //! } |
35 | 54 | //! ``` |
36 | 55 | //! |
37 | | -//! You can define three types of services: |
| 56 | +//! ## Service types |
| 57 | +//! Learn more about each service type: |
38 | 58 | //! - [Service](restate_sdk_macros::service) |
39 | 59 | //! - [Virtual Object](object) |
40 | 60 | //! - [Workflow](workflow) |
|
53 | 73 | //! - [Serving][crate::http_server]: Start an HTTP server to expose services. |
54 | 74 | //! |
55 | 75 | //! |
56 | | -//! # Logging |
| 76 | +//! ### Logging |
57 | 77 | //! |
58 | 78 | //! You can set the logging level of the Rust SDK via the `RESTATE_LOGGING` environment variable and the level values can be `TRACE`, `DEBUG`, `INFO`, `WARN` or `ERROR`. |
59 | | -//! |
60 | 79 | //! The default log level is `INFO`. |
61 | 80 | //! |
62 | 81 | //! If you set the level to `TRACE`, you can also get more verbose logging of the journal by setting the environment variable `RESTATE_JOURNAL_LOGGING=TRACE`. |
63 | 82 | //! |
| 83 | +//! # References |
64 | 84 | //! |
65 | 85 | //! For a general overview about Restate, check out the [Restate documentation](https://docs.restate.dev). |
| 86 | +//! |
| 87 | +//! You can find more Rust examples in the [examples repo](https://github.com/restatedev/examples) |
| 88 | +//! |
66 | 89 |
|
67 | 90 | pub mod endpoint; |
68 | 91 | pub mod service; |
|
0 commit comments