Struct RequestParser

Source

pub struct RequestParser { /* private fields */ }

Expand description

HTTP POSTリクエストのパーサー

Implementations§

Source §

impl RequestParser

Source

pub fn new(verification_token: &str) -> Self

新しいRequestParserを作成します。

§Arguments

verification_token - ボットのVerification Token

§Example

use traq_bot_http::RequestParser;
let parser = RequestParser::new("verification_token");

Source

pub fn parse_headers<'a, H, K, V>(&self, headers: H) -> Result<EventKind>
where H: IntoIterator<Item = (&'a K, &'a V)>, K: AsRef<[u8]> + ?Sized + 'static, V: AsRef<[u8]> + ?Sized + 'static,

POSTリクエストのヘッダーからイベント名を取得します。

§Arguments

headers - リクエストのヘッダー

§Example

use http::HeaderMap;
use traq_bot_http::RequestParser;

let parser = RequestParser::new("verification_token");
let headers = HeaderMap::new();
let kind = parser.parse_headers(&headers);
assert!(kind.is_err());

§Errors

Errorのうち、Error::kindが以下のものを返す可能性があります。

ErrorKind::ReadContentTypeFailed : ヘッダーContent-Typeの値をUTF8の文字列として解釈できなかった
ErrorKind::ContentTypeNotFound : ヘッダーContent-Typeが見つからなかった
ErrorKind::ContentTypeMismatch : ヘッダーContent-Typeの値がapplication/jsonで始まらない
ErrorKind::ReadBotTokenFailed : ヘッダーX-TRAQ-BOT-TOKENの値に関して、以下のいずれかの場合
- 値をUTF8の文字列として解釈できなかった
- 値がvisible US-ASCII octets (VCHAR), SP, HTAB以外の文字を含む (RFC9110 5.5)
ErrorKind::BotTokenNotFound : ヘッダーX-TRAQ-BOT-TOKENが見つからなかった
ErrorKind::BotTokenMismatch : ヘッダーX-TRAQ-BOT-TOKENの値がnewで与えられたVerification Tokenと合わない
ErrorKind::ReadBotEventFailed : ヘッダーX-TRAQ-BOT-EVENTの値に関して、以下のいずれかの場合
- 値をUTF8の文字列として解釈できなかった
- 値がvisible US-ASCII octets (VCHAR), SP, HTAB以外の文字を含む (RFC9110 5.5)
ErrorKind::BotEventNotFound : ヘッダーX-TRAQ-BOT-EVENTが見つからなかった
ErrorKind::BotEventMismatch : ヘッダーX-TRAQ-BOT-EVENTの値がEventKindのstd::str::FromStrでパースできなかった

Source

pub fn parse<'a, H, K, V>(&self, headers: H, body: &[u8]) -> Result<Event>
where H: IntoIterator<Item = (&'a K, &'a V)>, K: AsRef<[u8]> + ?Sized + 'static, V: AsRef<[u8]> + ?Sized + 'static,

HTTP POSTリクエストをパースします。

§Arguments

headers - リクエストのヘッダー
body - リクエストのボディ

§Example

use traq_bot_http::{RequestParser, Event};
let headers = [
    ("Content-Type", "application/json"),
    ("X-TRAQ-BOT-TOKEN", "verification_token"),
    ("X-TRAQ-BOT-EVENT", "PING"),
];
let body = br#"{"eventTime": "2019-05-07T04:50:48.582586882Z"}"#;
let verification_token = "verification_token";
let parser = RequestParser::new(verification_token);
let event = parser.parse(headers, body);
assert!(matches!(event, Ok(Event::Ping(_))));

§Errors

Errorのうち、Error::kindが以下のものを返す可能性があります。

parse_headersで返されるもの
ErrorKind::ReadBodyFailed : bodyをUTF8の文字列として解釈できなかった
ErrorKind::ParseBodyFailed : bodyをparse_headersで返されるEventKindに対応する EventのペイロードJSONとしてデシリアライズできなかった。

Source §

impl RequestParser

Source

pub async fn parse_request(&self, request: Request) -> Result<Event>
where B: Body, B::Error: Into<Box<dyn Error + Send + Sync + 'static>>,

http::Requestをパースします。

Note: この関数はhttpfeatureが有効になっている時のみ有効です。

§Arguments

request: リクエスト全体

§Example

use traq_bot_http::{EventKind, RequestParser};

let verification_token = "verification_token";
let body = r#"{"eventTime": "2019-05-07T04:50:48.582586882Z"}"#.to_string();
let request = http::Request::builder()
    .method(http::Method::POST)
    .header(http::header::CONTENT_TYPE, "application/json")
    .header("X-TRAQ-BOT-TOKEN", verification_token)
    .header("X-TRAQ-BOT-EVENT", "PING")
    .body(body)?;
let parser = RequestParser::new(verification_token);
let event = parser.parse_request(request).await?;
assert_eq!(event.kind(), EventKind::Ping);