core/src/raw/chrono_util.rs

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

use std::time::Duration;
use std::time::UNIX_EPOCH;

use chrono::DateTime;
use chrono::Utc;

use crate::*;

/// Parse datetime from rfc2822.
///
/// For example: `Fri, 28 Nov 2014 21:00:09 +0900`
pub fn parse_datetime_from_rfc2822(s: &str) -> Result<DateTime<Utc>> {
    DateTime::parse_from_rfc2822(s)
        .map(|v| v.into())
        .map_err(|e| {
            Error::new(ErrorKind::Unexpected, "parse datetime from rfc2822 failed").set_source(e)
        })
}

/// Parse datetime from rfc3339.
///
/// # Examples
///
/// With a time zone:
///
/// ```
/// use chrono::Datelike;
/// use opendal::raw::parse_datetime_from_rfc3339;
/// use opendal::Error;
///
/// let date_time = parse_datetime_from_rfc3339("2014-11-28T21:00:09+09:00")?;
/// assert_eq!(date_time.date_naive().day(), 28);
/// # Ok::<(), Error>(())
/// ```
///
/// With the UTC offset of 00:00:
///
/// ```
/// use chrono::Timelike;
/// # use opendal::Error;
/// # use opendal::raw::parse_datetime_from_rfc3339;
///
/// let date_time = parse_datetime_from_rfc3339("2014-11-28T21:00:09Z")?;
/// assert_eq!(date_time.hour(), 21);
/// # Ok::<(), Error>(())
/// ```
pub fn parse_datetime_from_rfc3339(s: &str) -> Result<DateTime<Utc>> {
    DateTime::parse_from_rfc3339(s)
        .map(|v| v.into())
        .map_err(|e| {
            Error::new(ErrorKind::Unexpected, "parse datetime from rfc3339 failed").set_source(e)
        })
}

/// parse datetime from given timestamp_millis
pub fn parse_datetime_from_from_timestamp_millis(s: i64) -> Result<DateTime<Utc>> {
    let st = UNIX_EPOCH
        .checked_add(Duration::from_millis(s as u64))
        .ok_or_else(|| Error::new(ErrorKind::Unexpected, "input timestamp overflow"))?;

    Ok(st.into())
}

/// parse datetime from given timestamp
pub fn parse_datetime_from_from_timestamp(s: i64) -> Result<DateTime<Utc>> {
    let st = UNIX_EPOCH
        .checked_add(Duration::from_secs(s as u64))
        .ok_or_else(|| Error::new(ErrorKind::Unexpected, "input timestamp overflow"))?;

    Ok(st.into())
}

/// format datetime into http date, this format is required by:
/// https://httpwg.org/specs/rfc9110.html#field.if-modified-since
pub fn format_datetime_into_http_date(s: DateTime<Utc>) -> String {
    s.format("%a, %d %b %Y %H:%M:%S GMT").to_string()
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_format_datetime_into_http_date() {
        let s = "Sat, 29 Oct 1994 19:43:31 +0000";
        let v = parse_datetime_from_rfc2822(s).unwrap();
        assert_eq!(
            format_datetime_into_http_date(v),
            "Sat, 29 Oct 1994 19:43:31 GMT"
        );
    }
}