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 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
use super::*;
/// Specialized expressions for [`Series`] with dates/datetimes.
pub struct DateLikeNameSpace(pub(crate) Expr);
impl DateLikeNameSpace {
/// Add a given number of business days.
#[cfg(feature = "business")]
pub fn add_business_days(
self,
n: Expr,
week_mask: [bool; 7],
holidays: Vec<i32>,
roll: Roll,
) -> Expr {
self.0.map_many_private(
FunctionExpr::Business(BusinessFunction::AddBusinessDay {
week_mask,
holidays,
roll,
}),
&[n],
false,
false,
)
}
/// Convert from Date/Time/Datetime into String with the given format.
/// See [chrono strftime/strptime](https://docs.rs/chrono/0.4.19/chrono/format/strftime/index.html).
pub fn to_string(self, format: &str) -> Expr {
let format = format.to_string();
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::ToString(
format,
)))
}
/// Convert from Date/Time/Datetime into String with the given format.
/// See [chrono strftime/strptime](https://docs.rs/chrono/0.4.19/chrono/format/strftime/index.html).
///
/// Alias for `to_string`.
pub fn strftime(self, format: &str) -> Expr {
self.to_string(format)
}
/// Change the underlying [`TimeUnit`]. And update the data accordingly.
pub fn cast_time_unit(self, tu: TimeUnit) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::CastTimeUnit(
tu,
)))
}
/// Change the underlying [`TimeUnit`] of the [`Series`]. This does not modify the data.
pub fn with_time_unit(self, tu: TimeUnit) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::WithTimeUnit(
tu,
)))
}
/// Change the underlying [`TimeZone`] of the [`Series`]. This does not modify the data.
#[cfg(feature = "timezones")]
pub fn convert_time_zone(self, time_zone: TimeZone) -> Expr {
self.0.map_private(FunctionExpr::TemporalExpr(
TemporalFunction::ConvertTimeZone(time_zone),
))
}
/// Get the millennium of a Date/Datetime
pub fn millennium(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::Millennium))
}
/// Get the century of a Date/Datetime
pub fn century(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::Century))
}
/// Get the year of a Date/Datetime
pub fn year(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::Year))
}
// Compute whether the year of a Date/Datetime is a leap year.
pub fn is_leap_year(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::IsLeapYear))
}
/// Get the iso-year of a Date/Datetime.
/// This may not correspond with a calendar year.
pub fn iso_year(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::IsoYear))
}
/// Get the month of a Date/Datetime.
pub fn month(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::Month))
}
/// Extract quarter from underlying NaiveDateTime representation.
/// Quarters range from 1 to 4.
pub fn quarter(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::Quarter))
}
/// Extract the week from the underlying Date representation.
/// Can be performed on Date and Datetime
/// Returns the ISO week number starting from 1.
/// The return value ranges from 1 to 53. (The last week of year differs by years.)
pub fn week(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::Week))
}
/// Extract the ISO week day from the underlying Date representation.
/// Can be performed on Date and Datetime.
/// Returns the weekday number where monday = 1 and sunday = 7
pub fn weekday(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::WeekDay))
}
/// Get the month of a Date/Datetime.
pub fn day(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::Day))
}
/// Get the ordinal_day of a Date/Datetime.
pub fn ordinal_day(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::OrdinalDay))
}
/// Get the (local) time of a Date/Datetime/Time.
pub fn time(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::Time))
}
/// Get the (local) date of a Date/Datetime.
pub fn date(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::Date))
}
/// Get the (local) datetime of a Datetime.
pub fn datetime(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::Datetime))
}
/// Get the hour of a Datetime/Time64.
pub fn hour(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::Hour))
}
/// Get the minute of a Datetime/Time64.
pub fn minute(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::Minute))
}
/// Get the second of a Datetime/Time64.
pub fn second(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::Second))
}
/// Get the millisecond of a Time64 (scaled from nanosecs).
pub fn millisecond(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::Millisecond))
}
/// Get the microsecond of a Time64 (scaled from nanosecs).
pub fn microsecond(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::Microsecond))
}
/// Get the nanosecond part of a Time64.
pub fn nanosecond(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::Nanosecond))
}
/// Return the timestamp (UNIX epoch) of a Datetime/Date.
pub fn timestamp(self, tu: TimeUnit) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::TimeStamp(tu)))
}
/// Truncate the Datetime/Date range into buckets.
pub fn truncate(self, every: Expr) -> Expr {
self.0.map_many_private(
FunctionExpr::TemporalExpr(TemporalFunction::Truncate),
&[every],
false,
false,
)
}
/// Roll backward to the first day of the month.
#[cfg(feature = "month_start")]
pub fn month_start(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::MonthStart))
}
/// Roll forward to the last day of the month.
#[cfg(feature = "month_end")]
pub fn month_end(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::MonthEnd))
}
/// Get the base offset from UTC.
#[cfg(feature = "timezones")]
pub fn base_utc_offset(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::BaseUtcOffset))
}
/// Get the additional offset from UTC currently in effect (usually due to daylight saving time).
#[cfg(feature = "timezones")]
pub fn dst_offset(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::DSTOffset))
}
/// Round the Datetime/Date range into buckets.
pub fn round(self, every: Expr) -> Expr {
self.0.map_many_private(
FunctionExpr::TemporalExpr(TemporalFunction::Round),
&[every],
false,
false,
)
}
/// Offset this `Date/Datetime` by a given offset [`Duration`].
/// This will take leap years/ months into account.
#[cfg(feature = "offset_by")]
pub fn offset_by(self, by: Expr) -> Expr {
self.0.map_many_private(
FunctionExpr::TemporalExpr(TemporalFunction::OffsetBy),
&[by],
false,
false,
)
}
#[cfg(feature = "timezones")]
pub fn replace_time_zone(
self,
time_zone: Option<TimeZone>,
ambiguous: Expr,
non_existent: NonExistent,
) -> Expr {
self.0.map_many_private(
FunctionExpr::TemporalExpr(TemporalFunction::ReplaceTimeZone(time_zone, non_existent)),
&[ambiguous],
false,
false,
)
}
/// Combine an existing Date/Datetime with a Time, creating a new Datetime value.
pub fn combine(self, time: Expr, tu: TimeUnit) -> Expr {
self.0.map_many_private(
FunctionExpr::TemporalExpr(TemporalFunction::Combine(tu)),
&[time],
false,
false,
)
}
/// Express a Duration in terms of its total number of integer days.
pub fn total_days(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::TotalDays))
}
/// Express a Duration in terms of its total number of integer hours.
pub fn total_hours(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::TotalHours))
}
/// Express a Duration in terms of its total number of integer minutes.
pub fn total_minutes(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::TotalMinutes))
}
/// Express a Duration in terms of its total number of integer seconds.
pub fn total_seconds(self) -> Expr {
self.0
.map_private(FunctionExpr::TemporalExpr(TemporalFunction::TotalSeconds))
}
/// Express a Duration in terms of its total number of milliseconds.
pub fn total_milliseconds(self) -> Expr {
self.0.map_private(FunctionExpr::TemporalExpr(
TemporalFunction::TotalMilliseconds,
))
}
/// Express a Duration in terms of its total number of microseconds.
pub fn total_microseconds(self) -> Expr {
self.0.map_private(FunctionExpr::TemporalExpr(
TemporalFunction::TotalMicroseconds,
))
}
/// Express a Duration in terms of its total number of nanoseconds.
pub fn total_nanoseconds(self) -> Expr {
self.0.map_private(FunctionExpr::TemporalExpr(
TemporalFunction::TotalNanoseconds,
))
}
}