mirrors/background-jobs
1
0
Fork 0
mirror of https://git.asonix.dog/asonix/background-jobs.git synced 2024-11-22 12:00:59 +00:00
Code Issues Projects Releases Packages Wiki Activity

Bump readme, lib docs

Browse source
This commit is contained in:
asonix 2019-09-22 13:13:05 -05:00
parent 436f92f6ba
commit b023978cf1
2 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -19,7 +19,7 @@ failure = "0.1"
futures = "0.1"
serde = "1.0"
serde_drive = "1.0"
sled = "0.1"
sled = "0.28"
```
#### To get started with Background Jobs, first you should define a job.

12
src/lib.rs
View file

@ -29,12 +29,12 @@
//! ```toml
//! [dependencies]
//! actix = "0.8"
//! background-jobs = "0.5.1"
//! background-jobs = "0.6.0"
//! failure = "0.1"
//! futures = "0.1"
//! serde = "1.0"
//! serde_drive = "1.0"
//! sled = "0.24"
//! sled = "0.28"
//! ```
//!
//! #### To get started with Background Jobs, first you should define a job.
@ -62,10 +62,14 @@
//! }
//!
//! impl Job for MyJob {
//! fn run(self, _: ()) -> Box<dyn Future<Item = (), Error = Error> + Send> {
//! type Processor = MyProcessor; // We'll define this later
//! type State = ();
//! type Future = Result<(), Error>;
//!
//! fn run(self, _: Self::State) -> Self::Future {
//! println!("args: {:?}", self);
//!
//! Box::new(Ok(()).into_future())
//! Ok(())
//! }
//! }
//! ```