rodolphe/rust-opensmtpd
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix the documentation

Browse source
This commit is contained in:
Rodolphe Bréard 2020-12-21 11:07:10 +01:00
parent a632035865
commit 758afdf28c
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
opensmtpd/src/lib.rs
View file

@ -6,12 +6,12 @@
//! # Writing a filter for OpenSMTPD //! # Writing a filter for OpenSMTPD
//! //!
//! The first step is to define an object (most of the time you want //! The first step is to define an object (most of the time you want
//! a struct) the implements the [`Filter`] trait. All of this //! a struct) that implements the [`Filter`] trait. All of this
//! trait's methods have an empty default implementation, so you only //! trait's methods have an empty default implementation, so you only
//! have to implement the ones that matters to you. For each method //! have to implement the ones that matters to you. For each method
//! you implement, you must use the [`register`] macro in order to //! you implement, you must use the [`opensmtpd_derive::register`]
//! ask OpenSMTPD to send you the corresponding events and filter //! attribute macro in order to ask OpenSMTPD to send you the
//! requests. //! corresponding events and filter requests.
//! //!
//! The second and last step is to call the [`run_filter`] function //! The second and last step is to call the [`run_filter`] function
//! with a mutable reference of your filter object. //! with a mutable reference of your filter object.
@ -42,7 +42,7 @@
//! } //! }
//! ``` //! ```
//! //!
//! More examples can be found in the [examples directory](https://github.com/breard-r/rust-opensmtpd/tree/main/examples). //! More examples can be found in the [examples directory](https://github.com/breard-r/rust-opensmtpd/tree/main/opensmtpd/examples).
mod data_line; mod data_line;
mod data_structures; mod data_structures;