Added description paragraph.

This commit is contained in:
Simon Johnston
2020-03-24 10:23:44 -07:00
parent 6a3d8f65e3
commit aa5c9cd809
2 changed files with 11 additions and 1 deletions
+5 -1
View File
@@ -9,7 +9,11 @@ A Rust crate providing an implementation of an RFC-compliant `EmailAddress` newt
[![travis.ci](https://travis-ci.org/johnstonskj/rust-email_address.svg?branch=master)](https://travis-ci.org/johnstonskj/rust-email_address) [![travis.ci](https://travis-ci.org/johnstonskj/rust-email_address.svg?branch=master)](https://travis-ci.org/johnstonskj/rust-email_address)
[![GitHub stars](https://img.shields.io/github/stars/johnstonskj/rust-email_address.svg)](https://github.com/johnstonskj/rust-email_address/stargazers) [![GitHub stars](https://img.shields.io/github/stars/johnstonskj/rust-email_address.svg)](https://github.com/johnstonskj/rust-email_address/stargazers)
TBD Primarily for validation, the `EmailAddress` type is constructed with `FromStr::from_str` which will raise any
parsing errors. Prior to constructions the functions `is_valid`, `is_valid_local_part`, and `is_valid_domain` may
also be used to test for validity without constructing an instance. This supports all of the RFC ASCII and UTF-8
character set rules, quoted and unquoted local parts but does not yet support all of the productions required for SMTP
headers; folding whitespace, comments, etc.
## Example ## Example
+6
View File
@@ -1,6 +1,12 @@
/*! /*!
A Rust crate providing an implementation of an RFC-compliant `EmailAddress` newtype. A Rust crate providing an implementation of an RFC-compliant `EmailAddress` newtype.
Primarily for validation, the `EmailAddress` type is constructed with `FromStr::from_str` which will raise any
parsing errors. Prior to constructions the functions `is_valid`, `is_valid_local_part`, and `is_valid_domain` may
also be used to test for validity without constructing an instance. This supports all of the RFC ASCII and UTF-8
character set rules, quoted and unquoted local parts but does not yet support all of the productions required for SMTP
headers; folding whitespace, comments, etc.
# Example # Example
The following shoes the basic `is_valid` and `from_str` functions. The following shoes the basic `is_valid` and `from_str` functions.