• Description
• Function Index
• Function Details

Ruby inspired calendar extension functions for Calendar module of Erlang.

Copyright © GPL 3.0 license

Version: 0.0.1

Authors: Aylin Ahmed ([email protected]).

Ruby inspired calendar extension functions for Calendar module of Erlang. This is a beta version of calendar extensions. Please be cautious while using it as it's not tested in any production environment yet thanks for your interest in trying it...

dayname_of_the_week() -> {integer(), string(), string()}
returns: Day number starting from 1, long name of the day and short name of the day.
Provides information of the current day in the current week in English.

dayname_of_the_week(DayNumber::integer() | calendar:datetime()) -> {integer(), string(), string()}
returns: Day number starting from 1, long name of the day and short name of the day.
Provides information of the day for the given datetime or given day number in English.

dayname_of_the_week(DayNumber::integer() | calendar:datetime(), LangCode::atom()) -> {integer(), string(), string()}
returns: Day number starting from 1, long name of the day and short name of the day.
Provides information of the current day for the given date time or given day number for the given ISO639-1 Language Code.

days_between(DateTimeFrom::calendar:datetime(), DateTimeTo::calendar:datetime()) -> integer()
returns: Total days between two days as integer.
Provides total difference in days between given two datetime. Second datetime's day is NOT counted within total days.

days_from_now(DateTimeTo::calendar:datetime()) -> integer()
returns: Total days between current datetime and given datetime as integer.
Provides total difference in days between current datetime and given datetime. Given datetime's day is NOT counted within total days.

days_since_begin_of_week() -> integer()
returns: Total days spent since the beginning of the week as integer().
Provides total days spent since the begining of the week for current datetime. Current day is also counted within total days.

days_since_begin_of_week(DateTime::calendar:datetime()) -> integer()
returns: Total days spent since the beginning of the week as integer().
Provides total days spent since the begining of the week for the given datetime. Given datetime's day is also counted within total days.

days_since_begin_of_year() -> integer()
returns: Total days spent since the beginning of the year as integer().
Provides total days spent since the begining of the year for current datetime. Current datetime is NOT counted within total days.

days_since_begin_of_year(DateTime::calendar:datetime()) -> integer()
returns: Total days spent since the beginning of the year as integer().
Provides total days spent since the begining of the year for the given datetime. Current datetime is NOT counted within total days.

days_until_end_of_week() -> integer()
returns: Total days between current datetime and the end of current week as integer.
Provides total days between current datetime and the end of the current week.

days_until_end_of_week(DateTime::calendar:datetime()) -> integer()
returns: Total days between given datetime and the end of the given datetime's week as integer.
Provides total days between given datetime and the end of the given datetime's week.

days_until_end_of_year() -> integer()
returns: Total days between current datetime and the end of the current datetime's year as integer.
Provides total days between current datetime and the end of the current datetime's year.

days_until_end_of_year(DateTime::calendar:datetime()) -> integer()
returns: Total days between given datetime and the end of the given datetime's year as integer.
Provides total days between given datetime and the end of the given datetime's year.

days_until_now(DateTimeFrom::calendar:datetime()) -> integer()
returns: Total days between given datetime and current datetime as integer.
Provides total difference in days between given datetime and current day. Current datetime's day is NOT counted within total days.

end_of_the_day() -> calendar:datetime()
returns: End of the Day including last second of the day as datetime.
Provides End of the Day information as datetime for current datetime.

end_of_the_day(DateTime::calendar:datetime()) -> calendar:datetime()
returns: End of the Day including last second of the day as datetime.
Provides End of the Day information as datetime for the given datetime.

end_of_the_hour() -> calendar:datetime()
returns: End of the Hour including last second of the day as datetime.
Provides End of the Hour information as datetime for current datetime.

end_of_the_hour(DateTime::calendar:datetime()) -> calendar:datetime()
returns: End of the Hour including last second of the day as datetime.
Provides End of the Hour information as datetime for the given datetime.

end_of_the_minute() -> calendar:datetime()
returns: End of the Minute including last second of the day as datetime.
Provides End of the Minute information as datetime for the current datetime.

end_of_the_minute(DateTime::calendar:datetime()) -> calendar:datetime()
returns: End of the Minute including last second of the day as datetime.
Provides End of the Minute information as datetime for the given datetime.

end_of_the_month() -> calendar:datetime()
returns: End of the Month including last second of the day as datetime.
Provides End of the Month information as datetime for current datetime.

end_of_the_month(DateTime::calendar:datetime()) -> calendar:datetime()
returns: End of the Month including last second of the day as datetime.
Provides End of the Month information as datetime for the given datetime.

end_of_the_week() -> calendar:datetime()
returns: End of the Week including last second of the day as datetime.
Provides End of the Week information as datetime for current datetime.

end_of_the_week(DateTime::calendar:datetime()) -> calendar:datetime()
returns: End of the Week including last second of the day as datetime.
Provides End of the Week information as datetime for the given datetime.

epoch() -> integer()
returns: Total seconds as integer.
Provides Unix epoch as integer.

epoch_start_date() -> calendar:datetime()
returns: Epoch start date in datetime.
Provides Unix epoch start date information.

format(Format::string(), DateTime::calendar:datetime()) -> string()
returns: Formatted datetime string as state in string formatters.
Provides formatted reresentation of the given datetime by Ruby inspired date time formats.

--- CONVERSION SPECIFIERS ---

%Y - Year including century, zero-padded: 2022
%y - Year without century, in range (0.99), zero-padded: 22
%C - Century, zero-padded: 20
%m - Month of the year, in range (1..12), zero-padded: 01
%B - Full month name, capitalized: January
%b - Abbreviated month name, capitalized: Jan
%h - Same as %b.
%d - Day of the month, in range (1..31), zero-padded: 01
%e - Day of the month, in range (1..31), blank-padded: " 1”
%j - Day of the year, in range (1..366), zero-padded: 125
%H - Hour of the day, in range (0..23), zero-padded: 12
%k - Hour of the day, in range (0..23), blank-padded: " 1”
%I - Hour of the day, in range (1..12), zero-padded: 08
%l - Hour of the day, in range (1..12), blank-padded: " 8”
%P - Meridian indicator, lowercase: am, pm
%p - Meridian indicator, uppercase: AM, PM
%M - Minute of the hour, in range (0..59), zero-padded: 57
%S - Second of the minute in range (0..59), zero-padded: 18
%s - Number of seconds since the epoch: 1656505136
%A - Full weekday name: Wednesday
%a - Abbreviated weekday name: Wed
%u - Day of the week, in range (1..7), Monday is 1: 2
%w - Day of the week, in range (0..6), Sunday is 0: 0
%Z - Timezone as hour and minute offset from UTC: +01:00:00
%W - Week number of the year, in range (0..53), zero-padded, where each week begins on a Monday: 26

--- SHORTHAND CONVERSION SPECIFIERS ---  

%c - Date and time: "Wed Jun 29 08:01:41 2022", shorthand for '%a %b %e %T %Y’
%D - Date: "06/29/22", shorthand for ‘%m/%d/%y'
%F - ISO 8601 date: "2022-06-29", shorthand for ‘%Y-%m-%d'
%v - VMS date: "29-JUN-2022", shorthand for ‘%e-%^b-%Y'
%x - Same as %D
%X - Same as %T
%r - 12-hour time: "01:00:00 AM", shorthand for '%I:%M:%S %p’
%R - 24-hour time: "01:00", shorthand for ‘%H:%M'
%T - 24-hour time: "01:00:00", shorthand for ‘%H:%M:%S'
%+ - Date and time: "Wed Jun 29 08:31:53 -05:00 2022", shorthand for '%a %b %e %H:%M:%S %Z %Y’

last_month() -> calendar:datetime()
returns: Last Month as datetime.
Provides Last Month's information as datetime for current datetime.

last_month(DateTime::calendar:datetime()) -> calendar:datetime()
returns: Last Month as datetime.
Provides Last Month's information as datetime for the given datetime.

last_year() -> calendar:datetime()
returns: Last Year as datetime.
Provides Last Year's information as datetime for current datetime.

last_year(DateTime::calendar:datetime()) -> calendar:datetime()
returns: Last Year as datetime.
Provides Last Year's information as datetime for the given datetime.

middle_of_the_day() -> calendar:datetime()
returns: Mid of the Day as datetime.
Provides Mid of the Day information as datetime for the current datetime.

middle_of_the_day(DateTime::calendar:datetime()) -> calendar:datetime()
returns: Mid of the Day as datetime.
Provides Mid of the Day information as datetime for the given datetime.

month_name() -> {integer(), string(), string()}
returns: Month numbers starting from 1, long month name, short month name.
Provides month name for current datetime.

month_name(MonthNumber::integer() | calendar:datetime()) -> {integer(), string(), string()}
returns: Month numbers starting from 1, long month name, short month name.
Provides month name for the given datetime or month number.

month_name(MonthNumber::integer() | calendar:datetime(), LangCode::atom()) -> {integer(), string(), string()}
returns: Month numbers starting from 1, long month name, short month name.
Provides month name for the given datetime or month number for the given ISO639-1 Language code.

next_month() -> calendar:datetime()
returns: Next Month as datetime.
Provides Next Month's information as datetime for current datetime.

next_month(DateTime::calendar:datetime()) -> calendar:datetime()
returns: Next Month as datetime.
Provides Next Month's information as datetime for the given datetime.

next_year() -> calendar:datetime()
returns: Next Year as datetime.
Provides Next Year's information as datetime for current datetime.

next_year(DateTime::calendar:datetime()) -> calendar:datetime()
returns: Next Year as datetime.
Provides Next Year's information as datetime for the given datetime.

seconds_between(DateTimeFrom::calendar:datetime(), DateTimeTo::calendar:datetime()) -> integer()
returns: Total seconds between two days as integer.
Provides total difference in seconds between given two datetime.

seconds_since_begin_of_year() -> integer()
returns: Total seconds spent since the beginning of the year as integer.
Provides Total seconds spent since the beginning of the year information as datetime for current datetime.

seconds_since_begin_of_year(DateTime::calendar:datetime()) -> integer()
returns: Total seconds spent since the beginning of the year as integer.
Provides Total seconds spent since the beginning of the year information as datetime for the given datetime.

seconds_since_midnight() -> integer()
returns: Total seconds spent since the midnight as integer.
Provides Total seconds spent since the midnight information as datetime for current datetime.

seconds_since_midnight(DateTime::calendar:datetime()) -> integer()
returns: Total seconds spent since the midnight as integer.
Provides Total seconds spent since the midnight information as datetime for the given datetime.

seconds_until_end_of_day() -> integer()
returns: Total seconds until the end of the current datetime as integer.
Provides total seconds from current datetime and the end of current datetime's day.

seconds_until_end_of_day(DateTime::calendar:datetime()) -> integer()
returns: Total seconds until the end of the given datetime as integer.
Provides total seconds from given datetime and the end of given datetime's day.

seconds_until_end_of_year() -> integer()
returns: Total seconds until the end of the current datetime's last day in the year as integer.
Provides total seconds from currnet datetime and the end of the current year.

seconds_until_end_of_year(DateTime::calendar:datetime()) -> integer()
returns: Total seconds until the end of the given datetime's last day as integer.
Provides total seconds from given datetime and the end of given datetime's last day in its year.

start_of_the_day() -> calendar:datetime()
returns: Start of the Day as datetime.
Provides Start of the Day information as datetime for current datetime.

start_of_the_day(DateTime::calendar:datetime()) -> calendar:datetime()
returns: Start of the Day as datetime.
Provides Start of the Day information as datetime for the given datetime.

start_of_the_hour() -> calendar:datetime()
returns: Start of the Hour as datetime.
Provides Start of the Hour information as datetime for current datetime.

start_of_the_hour(DateTime::calendar:datetime()) -> calendar:datetime()
returns: Start of the Hour as datetime.
Provides Start of the Hour information as datetime for the given datetime.

start_of_the_minute() -> calendar:datetime()
returns: Start of the Minute as datetime.
Provides Start of the Minute information as datetime for current datetime.

start_of_the_minute(DateTime::calendar:datetime()) -> calendar:datetime()
returns: Start of the Minute as datetime.
Provides Start of the Minute information as datetime for the given datetime.

start_of_the_month() -> calendar:datetime()
returns: Start of the Day as datetime.
Provides Start of the Day information as datetime for current datetime.

start_of_the_month(DateTime::calendar:datetime()) -> calendar:datetime()
returns: Start of the Day as datetime.
Provides Start of the Day information as datetime for the given datetime.

start_of_the_week() -> calendar:datetime()
returns: Start of the Week as datetime.
Provides Start of the Week information as datetime for current datetime.

start_of_the_week(DateTime::calendar:datetime()) -> calendar:datetime()
returns: Start of the Week as datetime.
Provides Start of the Week information as datetime for the given datetime.

tomorrow() -> calendar:datetime()
returns: Tomorrow as datetime.
Provides Tomorrow's information as datetime for current day.

tomorrow(DateTime::calendar:datetime()) -> calendar:datetime()
returns: Tomorrow as datetime.
Provides Tomorrow's information as datetime for the given datetime.

total_seconds(X1::atom()) -> integer()
returns: Total seconds as integer.
Provides total seconds by day, hour or minute.

until_epoch() -> integer()
returns: Total seconds in between AD and Unix epoch.
Provides time spent since the AD.

week_number() -> integer()
returns: Week number of current datetime as integer.
Provides week number of current datetime.

week_number(DateTime::calendar:datetime()) -> integer()
returns: Week number of the given datetime as integer.
Provides week number of the given datetime.

yesterday() -> calendar:datetime()
returns: Yesterday as datetime.
Provides Yesterday's information as datetime for current day.

yesterday(DateTime::calendar:datetime()) -> calendar:datetime()
returns: Yesterday as datetime.
Provides Yesterday's information as datetime for the given datetime.