1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
// timespan - A simple timespan for chrono times. // // Copyright (C) 2017 // Fin Christensen <christensen.fin@gmail.com> // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with this program. If not, see <http://www.gnu.org/licenses/>. //! # Timespan Library for Rust //! [](https://crates.io/crates/timespan) //! [](https://github.com/fin-ger/rust-timespan/releases) //! [](https://travis-ci.org/fin-ger/rust-timespan) //! [](https://docs.rs/timespan/) //! [](https://fin-ger.github.io/rust-timespan/) //! //! A simple timespan for chrono times. //! //! ## Usage //! //! Put this in your `Cargo.toml`: //! //! ```toml //! [dependencies] //! timespan = "^0" //! ``` //! //! Or, if you want [Serde](https://github.com/serde-rs/serde) support, include it like this: //! //! ```toml //! [dependencies] //! timespan = { version = "^0", features = ["with-serde"] } //! ``` //! //! Then put this in your crate root: //! //! ```rust //! extern crate timespan; //! ``` //! //! ## Overview //! //! ## Date and Time Spans //! //! `Timespan` can be used to create a time zone aware span consisting of `chrono::DateTime`s. //! //! Currently the `DateTimeSpan` supports serialization and deserialization for the `chrono::Utc`, //! `chrono::Local` and `chrono::FixedOffset` time zones. For support of other time zone types //! please refer to the [documentation](https://docs.rs/timespan/). //! //! When the `with-serde` feature is enabled `DateTimeSpan` has support for //! [`serde`](https://github.com/serde-rs/serde) serialization and deserialization. //! //! ```rust //! # extern crate timespan; extern crate chrono; fn main() { //! use timespan::DateTimeSpan; //! use chrono::Utc; //! //! let a: DateTimeSpan<Utc> = "2017-01-01T15:10:00 +0200 - 2017-01-02T09:30:00 +0200" //! .parse().unwrap(); //! //! assert!( //! format!("{}", a.format("{start} to {end}", "%c", "%c")) == //! "Sun Jan 1 13:10:00 2017 to Mon Jan 2 07:30:00 2017" //! ); //! # } //! ``` //! //! ## Individual Date Spans //! //! A `DateSpan` can be used to create a time zone aware span consisting of `chrono::Date`s. //! //! Currently the `DateSpan` does *not* support serialization and deserialization from strings. //! //! ```rust //! # extern crate timespan; extern crate chrono_tz; fn main() { //! use timespan::DateSpan; //! use chrono_tz::Europe::Paris; //! //! let a = DateSpan::from_utc_datespan( //! &"1789-06-17 - 1799-11-10".parse().unwrap(), //! &Paris, //! ); //! //! let f = a.format( //! "The french revolution lasted from the {start} to the {end}.", //! "%eth of %B %Y", //! "%eth of %B %Y", //! ); //! assert!( //! format!("{}", f) == //! "The french revolution lasted from the 17th of June 1789 to the 10th of November 1799." //! ); //! # } //! ``` //! //! ## Naive Date and Time Spans //! //! The `NaiveDateSpan`, `NaiveTimeSpan` and `NaiveDateTimeSpan` are all not aware of time zones //! and can be used for simple time spans. //! //! All naive spans have full support for serialization and deserialization from strings. //! //! When the `with-serde` feature is enabled all naive spans have support for //! [`serde`](https://github.com/serde-rs/serde) serialization and deserialization. //! //! ```rust //! use timespan::NaiveDateSpan; //! //! let a: NaiveDateSpan = "2017-04-15 - 2017-08-15".parse().unwrap(); //! let b = NaiveDateSpan::parse_from_str( //! "15.04.17 - 15.08.17", //! "{start} - {end}", //! "%d.%m.%y", "%d.%m.%y" //! ).unwrap(); //! //! let f = a.format("from {start} to {end}", "%m/%d", "%m/%d"); //! assert!(format!("{}", f) == "from 04/15 to 08/15"); //! assert!(a == b); //! ``` //! //! ```rust //! use timespan::NaiveTimeSpan; //! //! let a: NaiveTimeSpan = "17:30:00 - 19:15:00".parse().unwrap(); //! let b = NaiveTimeSpan::parse_from_str( //! "05.30 PM - 07.15 PM", //! "{start} - {end}", //! "%I.%M %P", "%I.%M %P" //! ).unwrap(); //! //! let f = a.format("from {start} to {end}", "%R", "%R"); //! assert!(format!("{}", f) == "from 17:30 to 19:15"); //! assert!(a == b); //! ``` //! //! ```rust //! use timespan::NaiveDateTimeSpan; //! //! let a: NaiveDateTimeSpan = "2017-02-20T11:30:00 - 2017-02-23T18:00:00".parse().unwrap(); //! let b = NaiveDateTimeSpan::parse_from_str( //! "02/20/17 11.30 am - 02/23/17 06.00 pm", //! "{start} - {end}", //! "%D %I.%M %p", "%D %I.%M %p" //! ).unwrap(); //! //! let f = a.format("from {start} to {end}", "%R on %A", "%R on %A"); //! assert!(format!("{}", f) == "from 11:30 on Monday to 18:00 on Thursday"); //! assert!(a == b); //! ``` //! //! ## How to Run the Examples //! //! In order to run an example from the `example` folder issue the following command. //! //! ```sh //! $ cargo run --example <name> //! ``` //! //! ### The `convert` Example //! //! Convert `from 10.30 to 14.00` to `10:30 - 14:00`: //! //! ```sh //! $ cargo run --example convert -- "from 10.30 to 14.00" \ //! "from {start} to {end}" "%H.%M" "%H.%M" \ //! "{start} - {end}" "%R" "%R" //! ``` //! //! ### The `duration` Example //! //! Get the duration of the time span `from 10.30 to 14.00`: //! //! ```sh //! $ cargo run --example duration -- "from 10.30 to 14.00" \ //! "from {start} to {end}" "%H.%M" "%H.%M" //! ``` //! //! ### The `contains` Example //! //! Get whether `11.20` is contained in the time span `from 10.30 to 14.00`: //! //! ```sh //! $ cargo run --example contains -- "from 10.30 to 14.00" "11.20" \ //! "from {start} to {end}" "%H.%M" "%H.%M" "%H.%M" //! ``` //! //! ## License //! //! This project is licensed under the GPL-v3 license - see the [LICENSE](LICENSE) file for details. #[cfg(feature = "serde")] extern crate serde; #[cfg(test)] extern crate serde_json; #[cfg(all(test, feature = "with-serde"))] #[cfg_attr(all(test, feature = "with-serde"), macro_use)] extern crate serde_derive; extern crate chrono; extern crate regex; #[cfg(feature = "chrono-tz")] extern crate chrono_tz; mod date_span; mod date_time_span; mod delayed_format; mod error; mod span; mod traits; pub mod naive; #[cfg(test)] mod delayed_format_test; #[cfg(test)] mod span_test; pub use self::date_span::DateSpan; pub use self::date_time_span::DateTimeSpan; pub use self::delayed_format::DelayedFormat; pub use self::error::Error; pub use self::naive::NaiveDateSpan; pub use self::naive::NaiveDateTimeSpan; pub use self::naive::NaiveTimeSpan; pub use self::span::Span; pub use self::traits::Formatable; pub use self::traits::Parsable; pub use self::traits::Spanable;