Merge pull request #114 from emwalker/chrono-timestamps

Add support for chrono::DateTime<T>
matsadler · Jul 23, 2024 · 4125ee2 · 4125ee2
2 parents 4109aec + 369da4e
commit 4125ee2
Show file tree

Hide file tree

Showing 6 changed files with 343 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,8 @@
 ## [Unreleased]
 ### Added
 - `Ruby::time_nano_new`, `Time::tv_sec`, `Time::tv_usec` and `Time::tv_nsec`.
+- The `chrono` feature can be enabled to allow automatic conversions
+  between `chrono::DateTime<Utc>` and `chrono::DateTime<FixedOffset>` and Ruby `Time` objects.
 
 ### Changed
 - Conversions between Ruby's `Time` and Rust's `SystemTime` now preserve

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -23,12 +23,14 @@ exclude = [
 [features]
 default = ["old-api"]
 bytes = ["dep:bytes"]
+chrono = ["dep:chrono"]
 embed = ["rb-sys/link-ruby"]
 old-api = []
 rb-sys = []
 
 [dependencies]
 bytes = { version = "1", optional = true }
+chrono = { version = "0.4.38", optional = true }
 magnus-macros = { version = "0.6.0", path = "magnus-macros" }
 rb-sys = { version = "0.9.85", default-features = false, features = [
     "bindgen-rbimpls",
@@ -42,6 +44,7 @@ magnus = { path = ".", default-features = false, features = [
     "embed",
     "rb-sys",
     "bytes",
+    "chrono",
 ] }
 rb-sys = { version = "0.9", default-features = false, features = [
     "stable-api-compiled-fallback",

diff --git a/README.md b/README.md
@@ -319,7 +319,7 @@ See `magnus::TryConvert` for more details.
 | `i8`,`i16`,`i32`,`i64`,`isize`, `magnus::Integer`                    | `Integer`, `#to_int`                    |
 | `u8`,`u16`,`u32`,`u64`,`usize`                                       | `Integer`, `#to_int`                    |
 | `f32`,`f64`, `magnus::Float`                                         | `Float`, `Numeric`                      |
-| `String`, `PathBuf`, `char`, `magnus::RString`, `bytes::Bytes`\*\*\* | `String`, `#to_str`                     |
+| `String`, `PathBuf`, `char`, `magnus::RString`, `bytes::Bytes`‡      | `String`, `#to_str`                     |
 | `magnus::Symbol`                                                     | `Symbol`, `#to_sym`                     |
 | `bool`                                                               | any object                              |
 | `magnus::Range`                                                      | `Range`                                 |
@@ -329,17 +329,19 @@ See `magnus::TryConvert` for more details.
 | `[T; N]`                                                             | `[T]`, `#to_ary`                        |
 | `magnus::RArray`                                                     | `Array`, `#to_ary`                      |
 | `magnus::RHash`                                                      | `Hash`, `#to_hash`                      |
-| `std::time::SystemTime`, `magnus::Time`                              | `Time`                                  |
+| `std::time::SystemTime`, `magnus::Time`, `chrono::DateTime<T>`§      | `Time`                                  |
 | `magnus::Value`                                                      | any object                              |
 | `Vec<T>`\*                                                           | `[T]`, `#to_ary`                        |
 | `HashMap<K, V>`\*                                                    | `{K => V}`, `#to_hash`                  |
-| `&T`, `typed_data::Obj<T>` where `T: TypedData`\*\*                  | instance of `<T as TypedData>::class()` |
+| `&T`, `typed_data::Obj<T>` where `T: TypedData`†                     | instance of `<T as TypedData>::class()` |
 
 \* when converting to `Vec` and `HashMap` the types of `T`/`K`,`V` must be native Rust types.
 
-\*\* see the `wrap` macro.
+† see the `wrap` macro.
 
-\*\*\* when the `bytes` feature is enabled
+‡ when the `bytes` feature is enabled
+
+§ when the `chrono` feature is enabled; `T` can be `Utc` or `FixedOffset`.
 
 ### Rust returning / passing values to Ruby
 
@@ -360,9 +362,9 @@ and `magnus::ArgList` for some additional details.
 | `(T, U)`, `(T, U, V)`, etc, `[T; N]`, `Vec<T>`     | `Array`                                 |
 | `HashMap<K, V>`                                    | `Hash`                                  |
 | `std::time::SystemTime`                            | `Time`                                  |
-| `T`, `typed_data::Obj<T>` where `T: TypedData`\*\* | instance of `<T as TypedData>::class()` |
+| `T`, `typed_data::Obj<T>` where `T: TypedData`\*  | instance of `<T as TypedData>::class()` |
 
-\*\* see the `wrap` macro.
+\* see the `wrap` macro.
 
 ### Conversions via Serde