Crate dyer[−][src]
Expand description
dyer is designed for reliable, flexible and fast Request-Response based service, including data processing, web-crawling and so on, providing some friendly, flexible, comprehensive features without compromising speed.
dyer
provides some high-level features:
- asynchronous, lock-free, concurrent streaming and I/O, make the best of thread pool, network, and system resource.
- Event-driven, once you set the initials and recursive generator,
dyer
will handle the rest of it. - User-friendly and flexible,
dyer
offers high-level, easy to use wrappers and APIs what does a lot for you.
Get started by installing dyer-cli and looking over the examples.
Quick Start
dyer-cli is a handy tool for your easy and fast use of dyer, and recommanded to intergrate
Prerequisite
rust
andcargo
must be installed,- OpenSSL library is required to compile openssl-sys(if not installed, see here)
the following code helps you get the tool:
cargo install dyer-cli
Once installed, run dyer
in your terminal or cmd prompt, it prints some info like
Handy tool for dyer
then dyer-cli is successfully installed.
Create A Project
Dyer-cli generates a template that contains many useful instances and instructions when using dyer with following code:
dyer new myproject
It will create a project called myproject
and the files layout displays:
|___Cargo.toml
|___Readme.md
|___data/
|___data/tasks/
|___src/
|___src/affix.rs
|___src/entity.rs
|___src/parser.rs
|___src/actor.rs
|___src/middleware.rs
|___src/pipeline.rs
Main functionality of each file:
- the
affix.rs
serves as an actor to adjust and satisfy additional requirement - the
entity.rs
contains entities/data structure to be used/collected - the
parser.rs
contains functions that extract entities from response - the
actor.rs
contains initial when opening and final things to do when closing - the
middleware.rs
contains Some middlewares that process data at runtime - the
pipeline.rs
contains entities manipulation including data-storage, displsying and so on - the
lib.rs
exports all modules inside the directory, just do nothing here normally Cargo.toml
is the basic configuration of the projectREADME.md
contains some instructions of the projectdata/
place to store/load files ofApp
when load-balancing and backup
Then it is your show time, basically there are simple example items(function
, enum
, struct
)
in each file you can follow. After that check your code
dyer check
if you run it the first time, dyer-cli will download the crates and then check the code.
if some warning happens such as unused import
or dead code
the command does a lot for you:
dyer fix
A wraper of cargo fix
, if some warning happens such as unused import
or dead code
the command does a lot for you. However it won’t help if some errors occur, if so, you have to debug the code manually.
Edit dyer.cfg
file in the root directory
the file contains some configurations of ArgApp
that will update periodically, for more details see
dyer.cfg Configuration
When the program compiles, haha run it:
dyer run
Short as it seems, here represents the normal procedure to write your program. It is believed that learning by example is the best, and some examples are provided to illustrate how to use.
Features to be added
- Dyer-cli Command-Line Tool Support
- Interrupt and Resume Support
- Lock-free WorkFlow
- Multiple Actors, MiddleWares, PipeLines
- More to go
Problem And Feedback
It is, of course, probable that bugs and errors lie in somewhere, and defects may appear in an unexpected way, if you got any one, comments and suggestions are welcome, please new a issue in my github.
Modules
Contains some data structure that related to the content of HTTP
attribute macro of dyer
A structure that carries basic meta-data, including its origin, stime stamp, privilege, encoding and so on.
A lightweight logging facade.
Instructions of plugins including middleware, pipeline and their usage.
This module contains structs related to HTTP requests, notably the Request type itself as well as a builder to create requests. Typically you’ll import the http::Request type rather than reaching into this module itself.
HTTP response types.
This module contains structs related to HTTP requests,
some utilities that useful and convenience for dealing with data flow.
Structs
generally, it provide extra infomation , meta data required by server,
including User-Agent
, Accept-Encoding
and so on.
An abstraction and collection of data flow
To control the workflow of engine in dealing with Affix including using affix or not, the amount to use/generate
some infomation about dyer
at rumtime where speed and error-handler based on
A reference counted contiguous slice of memory.
basic meta data related 3 ranging
Meta Data of the Request
Meta Data of the Response
Meta Data of the Task
Represents a medium that handles the dataflow of App
Serve as an medium to create an instance of MiddleWare
the parsed result returned by parser
.
Serve as an medium to create an instance of PipeLine
An Wrapper of http::Request
An Wrapper of http::Response
An Task
consists of a head and a potentially optional body. The body component is
generic, enabling arbitrary types to represent the HTTP body. For example, the body could be
Vec
Statics
A vector of tuple which contians function name(&str) and function pointer (*const ()),
Traits
Although it starts a project, the work to do here is not very complicated it is as simple as setting up initial condition and other basic things.
Read bytes from a buffer.