Skip to content

Commit

Permalink
[poem-openapi] implement Type for chrono::NaiveDateTime, `chrono:…
Browse files Browse the repository at this point in the history
…:NaiveDate`, `chrono::NaiveTime` #252
  • Loading branch information
sunli829 committed Apr 11, 2022
1 parent 8858a15 commit 2147317
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 1 deletion.
4 changes: 4 additions & 0 deletions poem-openapi/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

# [1.3.22] 2022-4-1

- Implement `Type` for `chrono::NaiveDateTime`, `chrono::NaiveDate`, `chrono::NaiveTime` [#252](https://github.com/poem-web/poem/issues/252)

# [1.3.20] 2022-4-1

- Fixed `#[oai(default)]` not working with operation parameters.
Expand Down
69 changes: 68 additions & 1 deletion poem-openapi/src/types/external/datetime.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use std::borrow::Cow;

use chrono::{DateTime, FixedOffset, Local, Utc};
use chrono::{DateTime, FixedOffset, Local, NaiveDate, NaiveDateTime, NaiveTime, Utc};
use poem::web::Field;
use serde_json::Value;

Expand Down Expand Up @@ -78,3 +78,70 @@ macro_rules! impl_datetime_types {
impl_datetime_types!(DateTime<Utc>, "string", "date-time");
impl_datetime_types!(DateTime<Local>, "string", "date-time");
impl_datetime_types!(DateTime<FixedOffset>, "string", "date-time");

macro_rules! impl_naive_datetime_types {
($ty:ty, $type_name:literal, $format:literal) => {
impl Type for $ty {
const IS_REQUIRED: bool = true;

type RawValueType = Self;

type RawElementValueType = Self;

fn name() -> Cow<'static, str> {
concat!($type_name, "(", $format, ")").into()
}

fn schema_ref() -> MetaSchemaRef {
MetaSchemaRef::Inline(Box::new(MetaSchema::new_with_format($type_name, $format)))
}

fn as_raw_value(&self) -> Option<&Self::RawValueType> {
Some(self)
}

fn raw_element_iter<'a>(
&'a self,
) -> Box<dyn Iterator<Item = &'a Self::RawElementValueType> + 'a> {
Box::new(self.as_raw_value().into_iter())
}
}

impl ParseFromJSON for $ty {
fn parse_from_json(value: Option<Value>) -> ParseResult<Self> {
let value = value.unwrap_or_default();
if let Value::String(value) = value {
Ok(value.parse()?)
} else {
Err(ParseError::expected_type(value))
}
}
}

impl ParseFromParameter for $ty {
fn parse_from_parameter(value: &str) -> ParseResult<Self> {
Ok(value.parse()?)
}
}

#[poem::async_trait]
impl ParseFromMultipartField for $ty {
async fn parse_from_multipart(field: Option<Field>) -> ParseResult<Self> {
match field {
Some(field) => Ok(field.text().await?.parse()?),
None => Err(ParseError::expected_input()),
}
}
}

impl ToJSON for $ty {
fn to_json(&self) -> Option<Value> {
Some(Value::String(self.to_string()))
}
}
};
}

impl_naive_datetime_types!(NaiveDateTime, "string", "naive-date-time");
impl_naive_datetime_types!(NaiveDate, "string", "naive-date");
impl_naive_datetime_types!(NaiveTime, "string", "naive-time");

0 comments on commit 2147317

Please sign in to comment.