From 620eadefb663285156b0008a69cdd9f9b4523275 Mon Sep 17 00:00:00 2001 From: Vincent Prouillet Date: Sun, 8 Nov 2015 12:08:44 +0000 Subject: [PATCH] Updated docs --- Cargo.toml | 2 +- README.md | 10 ++++------ 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 12a1c97..edc93c2 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "jsonwebtoken" -version = "0.1.0" +version = "0.2.0" authors = ["Vincent Prouillet "] license = "MIT" readme = "README.md" diff --git a/README.md b/README.md index 9b81ac6..5e890c6 100644 --- a/README.md +++ b/README.md @@ -23,16 +23,14 @@ use jwt::{encode, decode, Algorithm}; ### Encoding ```rust -// encode(claims: T, secret: String, algorithm: Algorithm) -> Result -let token = encode::(my_claims, "secret".to_owned(), Algorithm::HS256); +let token = encode(&my_claims, "secret", Algorithm::HS256); ``` In that example, `my_claims` is an instance of the Claims struct. The struct you are using for your claims should derive `RustcEncodable` and `RustcDecodable`. ### Decoding ```rust -// decode(token: String, secret: String, algorithm: Algorithm) -> Result -let claims = decode::(token.to_owned(), "secret".to_owned(), Algorithm::HS256); +let claims = decode::(&token, "secret", Algorithm::HS256); ``` In addition to the normal base64/json decoding errors, `decode` can return two custom errors: @@ -54,6 +52,6 @@ The header is currently not customisable and therefore does not support things l On my thinkpad 440s for a 2 claims struct using SHA256: ``` -test bench_decode ... bench: 7,106 ns/iter (+/- 5,354) -test bench_encode ... bench: 3,453 ns/iter (+/- 140) +test bench_decode ... bench: 2,537 ns/iter (+/- 813) +test bench_encode ... bench: 2,847 ns/iter (+/- 131) ```