mirror of
https://gitee.com/dromara/carbon.git
synced 2024-11-30 03:07:36 +08:00
Migrated repository
| calendar.go | ||
| carbon_test.go | ||
| carbon.go | ||
| const.go | ||
| database.go | ||
| final_test.go | ||
| final.go | ||
| go.mod | ||
| LICENSE | ||
| private.go | ||
| README.en.md | ||
| README.md | ||
Carbon
Englsih | 中文
Description
A simple,semantic and IDE-friendly golang package for DateTime
If you feel good, please give me a star
github:github.com/golang-module/carbon
gitee:gitee.com/go-package/carbon
Installation
// By github
go get -u github.com/golang-module/carbon
import (
"github.com/golang-module/carbon"
)
// By gitee
go get -u gitee.com/go-package/carbon
import (
"gitee.com/go-package/carbon"
)
Usage and example
The default timezone is Local, assuming the current time is 2020-08-05 13:14:15
Set timezone
// Set global timezone
c := carbon.Timezone(carbon.PRC)
// Set temporary timezone
c.Timezone(carbon.Tokyo).Now().ToDateTimeString() // 2020-08-05 14:14:15
c.Now().ToDateTimeString() // 2020-08-05 13:14:15
For more timezone constants, please see the const.go file
Yesterday,Today and Tomorrow
// Datetime of today
carbon.Now().ToDateTimeString() // 2020-08-05 13:14:15
// Start date of today
carbon.Now().ToDateStartString() // 2020-08-05 00:00:00
// End date of today
carbon.Now().ToDateEndString() // 2020-08-05 23:59:59
// Date of today
carbon.Now().ToDateString() // 2020-08-05
// Time of today
carbon.Now().ToTimeString() // 13:14:15
// Timestamp of today
carbon.Now().ToTimestamp() // 1596604455
// Datetime of yesterday
carbon.Yesterday().ToDateTimeString() // 2020-08-04 13:14:15
// Start date of yesterday
carbon.Yesterday().ToDateStartString() // 2020-08-04 00:00:00
// End date of yesterday
carbon.Yesterday().ToDateEndString() // 2020-08-04 23:59:59
// Date of yesterday
carbon.Yesterday().ToDateString() // 2020-08-04
// Time of yesterday
carbon.Now().ToTimeString() // 13:14:15
// Timestamp of yesterday
carbon.Yesterday().ToTimestamp() // 1596518055
// Datetime of tomorrow
carbon.Tomorrow().ToDateTimeString() // 2020-08-06 13:14:15
// Start date of tomorrow
carbon.Tomorrow().ToDateStartString() // 2020-08-06 00:00:00
// End date of tomorrow
carbon.Tomorrow().ToDateEndString() // 2020-08-06 23:59:59
// Date of tomorrow
carbon.Tomorrow().ToDateString() // 2020-08-06
// Time of tomorrow
carbon.Now().ToTimeString() // 13:14:15
// Timestamp of tomorrow
carbon.Tomorrow().ToTimestamp() // 1596690855
First、Last
// Current time on the first day of the year
carbon.Parse("2020-08-05 13:14:15").FirstOfYear().ToDateTimeString() // 2020-01-01 13:14:15
// Start time on the first day of the year
carbon.Parse("2020-08-05 13:14:15").FirstOfYear().ToDateStartString() // 2020-01-01 00:00:00
// End time on the first day of the year
carbon.Parse("2020-08-05 13:14:15").FirstOfYear().ToDateEndString() // 2020-01-01 23:59:59
// Current time on the last day of the year
carbon.Parse("2020-08-05 13:14:15").LastOfYear().ToDateTimeString() // 2020-12-31 13:14:15
// Start time on the last day of the year
carbon.Parse("2020-08-05 13:14:15").LastOfYear().ToDateStartString() // 2020-12-31 00:00:00
// End time on the last day of the year
carbon.Parse("2020-08-05 13:14:15").LastOfYear().ToDateStartString() // 2020-12-31 23:59:59
// Current time on the first day of the month
carbon.Parse("2020-08-05 13:14:15").FirstOfMonth().ToDateTimeString() // 2020-08-01 13:14:15
// Start time on the first day of the month
carbon.Parse("2020-08-05 13:14:15").FirstOfMonth().ToDateStartString() // 2020-08-01 00:00:00
// End time on the first day of the month
carbon.Parse("2020-08-05 13:14:15").FirstOfMonth().ToDateStartString() // 2020-08-01 23:59:59
// Current time on the last day of the month
carbon.Parse("2020-08-05 13:14:15").LastOfMonth().ToDateTimeString() // 2020-08-31 13:14:15
// Start time on the last day of the month
carbon.Parse("2020-08-05 13:14:15").LastOfMonth().ToDateStartString() // 2020-08-31 00:00:00
// End time on the last day of the month
carbon.Parse("2020-08-05 13:14:15").LastOfMonth().ToDateStartString() // 2020-08-31 23:59:59
// Current time on the first day of the week
carbon.Parse("2020-08-05 13:14:15").FirstOfWeek().ToDateTimeString() // 2020-08-03 13:14:15
// Start time on the first day of the week
carbon.Parse("2020-08-05 13:14:15").FirstOfWeek().ToDateStartString() // 2020-08-03 00:00:00
// End time on the first day of the week
carbon.Parse("2020-08-05 13:14:15").FirstOfWeek().ToDateStartString() // 2020-08-03 23:59:59
// Current time on the last day of the week
carbon.Parse("2020-08-05 13:14:15").LastOfWeek().ToDateStartString() // 2020-08-09 13:14:15
// Start time on the last day of the week
carbon.Parse("2020-08-05 13:14:15").LastOfWeek().ToDateStartString() // 2020-08-09 00:00:00
// End time on the last day of the week
carbon.Parse("2020-08-05 13:14:15").LastOfWeek().ToDateStartString() // 2020-08-09 23:59:59
Create Carbon instance
// Create Carbon instance from timestamp
carbon.CreateFromTimestamp(1596604455).ToFormatString("Y-m-d H:i:s") // 2020-08-05 13:14:15
// Create Carbon instance from year,month,day,hour,minute and second
carbon.CreateFromDateTime(2020, 8, 5, 13, 14, 15).ToFormatString("Y-m-d H:i:s") // 2020-08-05 13:14:15
// Create Carbon instance from year,month and day
carbon.CreateFromDate(2020, 8, 5).ToFormatString("Y-m-d H:i:s") // 2020-08-05 13:14:15
// Create Carbon instance from hour,minute and second
carbon.CreateFromTime(13, 14, 15).ToFormatString("Y-m-d H:i:s") // 2020-08-05 13:14:15
Parse standard format time string
carbon.Parse("2020-08-05 13:14:15").ToFormatString("YmdHis") // 20200805131415
carbon.Parse("2020-08-05 13:14:15").ToFormatString("Y年m月d日 H时i分s秒") // 2020年08月05日 13时14分15秒
carbon.Parse("2020-08-05").ToFormatString("Y/m/d H:i:s") // 2020/09/08 00:00:00
carbon.Parse("2020-08-05").ToFormatString("Y/m/d") // 2020/09/08
carbon.Parse("2020-08-05 13:14:15").ToDateTimeString() // 2020-08-05 13:14:15
carbon.Parse("2020-08-05 13:14:15").ToDateStartString() // 2020-08-05 00:00:00
carbon.Parse("2020-08-05 13:14:15").ToDateEndString() // 2020-08-05 23:59:59
carbon.Parse("2020-08-05 13:14:15").ToDateString() // 2020-08-05
carbon.Parse("2020-08-05 13:14:15").ToTimeString() // 13:14:15
carbon.Parse("2020-08-05 13:14:15").ToTimestamp() // 1596604455
carbon.Parse("2020/08/05 13:14:15").ToFormatString("Y-m-d H:i:s") // 2020-08-05 13:14:15
carbon.Parse("2020/08/05 13/14/15").ToFormatString("Y-m-d") // 2020-08-05
carbon.Parse("2020/08/05").ToFormatString("Y-m-d H:i:s") // 2020-08-05 00:00:00
carbon.Parse("2020/08/05").ToFormatString("Y-m-d") // 2020-08-05
carbon.Parse("2020/08/05 13:14:15").ToDateTimeString() // 2020-08-05 13:14:15
carbon.Parse("2020/08/05 13:14:15").ToDateString() // 2020-09-08
carbon.Parse("2020/08/05 13:14:15").ToTimeString() // 13:14:15
carbon.Parse("2020/08/05 13:14:15").ToTimestamp() // 1596604455
carbon.Parse("20200805131415").ToFormatString("Y-m-d H:i:s") // 2020-08-05 13:14:15
carbon.Parse("20200805131415").ToFormatString("Y-m-d") // 2020-08-05
carbon.Parse("20200805131415").ToDateTimeString() // 2020-08-05 13:14:15
carbon.Parse("20200805131415").ToDateString() // 2020-09-08
carbon.Parse("20200805131415").ToTimeString() // 13:00:00
carbon.Parse("20200805131415").ToTimestamp() // 1596604455
carbon.Parse("20200805").ToFormatString("Y-m-d H:i:s") // 2020-08-05 00:00:00
carbon.Parse("20200805").ToFormatString("Y/m/d") // 2020/08/05
Parse custom format time string
carbon.ParseByFormat("2020|08|05 13:14:15", "Y|m|d H:i:s").ToFormatString("Y-m-d H:i:s") // 2020-08-05 13:14:15
carbon.ParseByFormat("2020%08%05% 13%14%15", "Y年m月d日 h%i%s").ToFormatString("Y-m-d H:i:s") // 2020-08-05 13:14:15
carbon.ParseByFormat("2020年08月05日 13:14:15", "Y年m月d日 H:i:s").ToFormatString("Y-m-d H:i:s") // 2020-08-05 13:14:15
carbon.ParseByFormat("2020年08月05日 13时14分15秒", "Y年m月d日 H时i分s秒").ToDateTimeString() // 2020-08-05 13:14:15
carbon.ParseByFormat("2020年08月05日 13时14分15秒", "Y年m月d日 H时i分s秒").ToDateString() // 2020-08-05
carbon.ParseByFormat("2020年08月05日 13时14分15秒", "Y年m月d日 H时i分s秒").ToTimeString() // 13:14:15
carbon.ParseByFormat("2020年08月05日 13时14分15秒", "Y年m月d日 H时i分s秒").ToTimestamp() // 1596604455
Parse duration time string (base on now)
// Ten hours later
carbon.ParseByDuration("10h").ToDateTimeString() // 2020-08-06 23:14:15
// Ten and a half hours ago
carbon.ParseByDuration("-10.5h").ToFormatString("Y-m-d H:i:s") // 2020-08-05 02:44:15
// Ten minutes later
carbon.ParseByDuration("10m").ToFormatString("Y-m-d H:i:s") // 2020-08-05 13:24:15
// Ten and a half minutes ago
carbon.ParseByDuration("-10.5m").ToFormatString("Y-m-d H:i:s") // 2020-08-05 13:03:45
// Ten seconds later
carbon.ParseByDuration("10s").ToFormatString("Y-m-d H:i:s") // 2020-08-05 13:14:25
// Ten seconds ago
carbon.ParseByDuration("-10.5s").ToFormatString("Y-m-d H:i:s") // 2020-08-05 13:14:04
Parse golang time.Time instance
carbon.ParseByTime(time.Now()).ToTimestamp() // 1596604455
carbon.ParseByTime(time.Now()).ToDateTimeString() // 2020-08-05 13:14:15
carbon.ParseByTime(time.Now().AddDate(0, 0, 1)).ToDateTimeString() // 2020-08-06 13:14:15
carbon.ParseByTime(time.Now().AddDate(0, 0, -1)).ToDateString() // 2020-08-05
Time travel
// After Three years
carbon.Parse("2020-02-29 13:14:15").AddYears(3).ToDateTimeString() // 2023-03-01 13:14:15
// Next three years
carbon.Parse("2020-02-29 13:14:15").NextYears(3).ToDateTimeString() // 2023-02-28 13:14:15
// After one year
carbon.Parse("2020-02-29 13:14:15").AddYear().ToDateTimeString() // 2021-03-01 13:14:15
// Next one year
carbon.Parse("2020-02-29 13:14:15").NextYear().ToDateTimeString() // 2021-02-28 13:14:15
// Before three years
carbon.Parse("2020-02-29 13:14:15").SubYears(3).ToDateTimeString() // 2017-03-01 13:14:15
// Previous three years
carbon.Parse("2020-02-29 13:14:15").PreYears(3).ToDateTimeString() // 2017-02-28 13:14:15
// After one year
carbon.Parse("2020-02-29 13:14:15").SubYear().ToDateTimeString() // 2019-03-01 13:14:15
// Previous one year
carbon.Parse("2020-02-29 13:14:15").PreYear().ToDateTimeString() // 2019-02-28 13:14:15
// After three months
carbon.Parse("2020-02-29 13:14:15").AddMonths(3).ToDateTimeString() // 2020-05-29 13:14:15
// Next three months
carbon.Parse("2020-02-29 13:14:15").NextMonths(3).ToDateTimeString() // 2020-05-29 13:14:15
// After one month
carbon.Parse("2020-01-31 13:14:15").AddMonth().ToDateTimeString() // 2020-03-02 13:14:15
// Next one month
carbon.Parse("2020-01-31 13:14:15").NextMonth().ToDateTimeString() // 2020-02-29 13:14:15
// After three months
carbon.Parse("2020-02-29 13:14:15").SubMonths(3).ToDateTimeString() // 2019-11-29 13:14:15
// Previous three months
carbon.Parse("2020-02-29 13:14:15").PreMonths(3).ToDateTimeString() // 2019-11-29 13:14:15
// After one month
carbon.Parse("2020-03-31 13:14:15").SubMonth().ToDateTimeString() // 2020-03-02 13:14:15
// Previous one month
carbon.Parse("2020-03-31 13:14:15").PreMonth().ToDateTimeString() // 2020-02-29 13:14:15
// After Three days
carbon.Parse("2020-08-05 13:14:15").AddDays(3).ToDateTimeString() // 2020-08-08 13:14:15
// After One day
carbon.Parse("2020-08-05 13:14:15").AddDay().ToDateTimeString() // 2020-08-05 13:14:15
// After three days
carbon.Parse("2020-08-05 13:14:15").SubDays(3).ToDateTimeString() // 2020-08-02 13:14:15
// After one day
carbon.Parse("2020-08-05 13:14:15").SubDay().ToDateTimeString() // 2020-08-04 13:14:15
// After three hours
carbon.Parse("2020-08-05 13:14:15").AddHours(3).ToDateTimeString() // 2020-08-05 16:14:15
// After two and a half hours
carbon.Parse("2020-08-05 13:14:15").Duration("2.5h").ToDateTimeString() // 2020-08-05 15:44:15
// After one hour
carbon.Parse("2020-08-05 13:14:15").AddHour().ToDateTimeString() // 2020-08-05 14:14:15
// Before three hours
carbon.Parse("2020-08-05 13:14:15").SubHours(3).ToDateTimeString() // 2020-08-05 10:14:15
// Before two and a half hours
carbon.Parse("2020-08-05 13:14:15").Duration("-2.5h").ToDateTimeString() // 2020-08-05 10:44:15
// Before one hour
carbon.Parse("2020-08-05 13:14:15").SubHour().ToDateTimeString() // 2020-08-05 12:14:15
// After three minutes
carbon.Parse("2020-08-05 13:14:15").AddMinutes(3).ToDateTimeString() // 2020-08-05 13:17:15
// After two and a half minutes
carbon.Parse("2020-08-05 13:14:15").Duration("2.5m").ToDateTimeString() // 2020-08-05 13:16:45
// After one minute
carbon.Parse("2020-08-05 13:14:15").AddMinute().ToDateTimeString() // 2020-08-05 13:15:15
// Before three minutes
carbon.Parse("2020-08-05 13:14:15").SubMinutes(3).ToDateTimeString() // 2020-08-05 13:11:15
// Before two and a half minutes
carbon.Parse("2020-08-05 13:14:15").Duration("-2.5m").ToDateTimeString() // 2020-08-05 13:11:45
// Before one minute
carbon.Parse("2020-08-05 13:14:15").SubMinute().ToDateTimeString() // 2020-08-05 13:13:15
// After three seconds
carbon.Parse("2020-08-05 13:14:15").AddSeconds(3).ToDateTimeString() // 2020-08-05 13:14:18
// After two and a half seconds
carbon.Parse("2020-08-05 13:14:15").Duration("2.5s").ToDateTimeString() // 2020-08-05 13:14:17
// After one second
carbon.Parse("2020-08-05 13:14:15").AddSecond().ToDateTimeString() // 2020-08-05 13:14:16
// Before three seconds
carbon.Parse("2020-08-05 13:14:15").SubSeconds(3).ToDateTimeString() // 2020-08-05 13:14:12
// Before two and a half seconds
carbon.Parse("2020-08-05 13:14:15").Duration("-2.5s").ToDateTimeString() // 2020-08-05 13:14:12
// Before one second
carbon.Parse("2020-08-05 13:14:15").SubSecond().ToDateTimeString() // 2020-08-05 13:14:14
Time output
// To timestamp
carbon.Parse("2020-08-05 13:14:15").ToTimestamp() // 1596604455
// To string
carbon.Parse("2020-08-05 13:14:15").Time.String() // 2020-08-05 13:14:15 +0800 CST
// To string of layout format
carbon.Parse("2020-08-05 13:14:15").ToFormatString("YmdHis") // 20200805131415
// To string of datetime format
carbon.Parse("2020-08-05 13:14:15").ToDateTimeString() // 2020-08-05 13:14:15
// To string of date format
carbon.Parse("2020-08-05 13:14:15").ToDateString() // 2020-08-05
// To string of start date format
carbon.Parse("2020-08-05 13:14:15").ToDateStartString() // 2020-08-05 00:00:00
// To string from end date format
carbon.Parse("2020-08-05 13:14:15").ToDateEndString() // 2020-08-05 23:59:59
// To string of time format
carbon.Parse("2020-08-05 13:14:15").ToTimeString() // 13:14:15
// To string of Ansic format
carbon.Parse("2020-08-05 13:14:15").ToAnsicString() // Wed Aug 5 13:14:15 2020
// To string of Atom format
carbon.Parse("2020-08-05 13:14:15").ToAtomString() // Wed Aug 5 13:14:15 2020
// To string of UnixDate format
carbon.Parse("2020-08-05 13:14:15").ToUnixDateString() // Wed Aug 5 13:14:15 CST 2020
// To string of RubyDate format
carbon.Parse("2020-08-05 13:14:15").ToRubyDateString() // Wed Aug 05 13:14:15 +0800 2020
// To string of Kitchen format
carbon.Parse("2020-08-05 13:14:15").ToKitchenString() // 1:14PM
// To string of Cookie format
carbon.Parse("2020-08-05 13:14:15").ToCookieString() // Wednesday, 05-Aug-2020 13:14:15 CST
// To string of DayDateTime format
carbon.Parse("2020-08-05 13:14:15").ToDayDateTimeString() // Wed, Aug 5, 2020 1:14 PM
// To string of RSS format
carbon.Parse("2020-08-05 13:14:15").ToRssString() // Wed, 05 Aug 2020 13:14:15 +0800
// To string of W3C format
carbon.Parse("2020-08-05 13:14:15").ToW3cString() // 2020-08-05T13:14:15+08:00
// To string of RFC822 format
carbon.Parse("2020-08-05 13:14:15").ToRFC822String() // 05 Aug 20 13:14 CST
// To string of RFC822Z format
carbon.Parse("2020-08-05 13:14:15").ToRFC822zString() // 05 Aug 20 13:14 +0800
// To string of RFC850 format
carbon.Parse("2020-08-05 13:14:15").ToRFC850String() // Wednesday, 05-Aug-20 13:14:15 CST
// To string of RFC1036 format
carbon.Parse("2020-08-05 13:14:15").ToRFC1036String() // Wed, 05 Aug 20 13:14:15 +0800
// To string of RFC1123 format
carbon.Parse("2020-08-05 13:14:15").ToRFC1123String() // Wed, 05 Aug 2020 13:14:15 CST
// To string of RFC2822 format
carbon.Parse("2020-08-05 13:14:15").ToRFC2822String() // Wed, 05 Aug 2020 13:14:15 +0800
// To string of RFC3339 format
carbon.Parse("2020-08-05 13:14:15").ToRFC3339String() // 2020-08-05T13:14:15+08:00
// To string of RFC7231 format
carbon.Parse("2020-08-05 13:14:15").ToRFC7231String() // Wed, 05 Aug 2020 05:14:15 GMT
For more format signs, please see the Format sign table
The total days
// Total days of the year
carbon.Parse("2020-08-05 13:14:15").DaysInYear() // 366
// Total days of the month
carbon.Parse("2020-08-05 13:14:15").DaysInMonth() // 31
The week/day
// Day of the year
carbon.Parse("2020-08-05 13:14:15").DayOfYear() // 218
// Week of the year
carbon.Parse("2020-08-05 13:14:15").WeekOfYear() // 32
// Day of the month
carbon.Parse("2020-08-05 13:14:15").DayOfMonth() // 5
// Week of the month
carbon.Parse("2020-08-05 13:14:15").WeekOfMonth() // 1
// Day of the week
carbon.Parse("2020-08-05 13:14:15").DayOfWeek() // 3
Time judgment
// Is zero time
carbon.Parse("").IsZero() // true
carbon.Parse("0000-00-00 00:00:00").IsZero() // true
carbon.Parse("2020-08-05 00:00:00").IsZero() // false
carbon.Parse("2020-08-05").IsZero() // false
// Is future time
carbon.Parse("2020-08-06 13:14:15").IsFuture() // true
// Is pass time
carbon.Parse("2020-08-04 13:14:15").IsPast() // true
// Is leap year
carbon.Parse("2020-08-05 13:14:15").IsLeapYear() // true
// Is January
carbon.Parse("2020-08-05 13:14:15").IsJanuary() // false
// Is February
carbon.Parse("2020-08-05 13:14:15").IsFebruary() // false
// Is March
carbon.Parse("2020-08-05 13:14:15").IsMarch() // false
// Is April
carbon.Parse("2020-08-05 13:14:15").IsApril() // false
// Is May
carbon.Parse("2020-08-05 13:14:15").IsMay() // false
// Is June
carbon.Parse("2020-08-05 13:14:15").IsJune() // false
// Is July
carbon.Parse("2020-08-05 13:14:15").IsJuly() // false
// Is August
carbon.Parse("2020-08-05 13:14:15").IsAugust() // false
// Is September
carbon.Parse("2020-08-05 13:14:15").IsSeptember() // true
// Is October
carbon.Parse("2020-08-05 13:14:15").IsOctober() // false
// Is November
carbon.Parse("2020-08-05 13:14:15").IsNovember() // false
// Is December
carbon.Parse("2020-08-05 13:14:15").IsDecember() // false
// Is Yesterday
carbon.Parse("2020-08-04 13:14:15").IsYesterday() // true
carbon.Parse("2020-08-04 00:00:00").IsYesterday() // true
carbon.Parse("2020-08-04").IsYesterday() // true
// Is Today
carbon.Parse("2020-08-05 13:14:15").IsToday() // true
carbon.Parse("2020-08-05 00:00:00").IsToday() // true
carbon.Parse("2020-08-05").IsToday() // true
// Is Tomorrow
carbon.Parse("2020-08-06 13:14:15").IsTomorrow() // true
carbon.Parse("2020-08-06 00:00:00").IsTomorrow() // true
carbon.Parse("2020-08-06").IsTomorrow() // true
// Is Monday
carbon.Parse("2020-08-05 13:14:15").IsMonday() // false
// Is Tuesday
carbon.Parse("2020-08-05 13:14:15").IsTuesday() // true
// Is Wednesday
carbon.Parse("2020-08-05 13:14:15").IsWednesday() // false
// Is Thursday
carbon.Parse("2020-08-05 13:14:15").IsThursday() // false
// Is Friday
carbon.Parse("2020-08-05 13:14:15").IsFriday() // false
// Is Saturday
carbon.Parse("2020-08-05 13:14:15").IsSaturday() // false
// Is Sunday
carbon.Parse("2020-08-05 13:14:15").IsSunday() // false
// Is Weekday
carbon.Parse("2020-08-05 13:14:15").IsWeekday() // false
// Is Weekend
carbon.Parse("2020-08-05 13:14:15").IsWeekend() // true
// Is first day of the year
carbon.Parse("2020-01-01").IsFirstOfYear() // true
carbon.Parse("2020-01-01 00:00:00").IsFirstOfYear() // true
carbon.Parse("2020-01-01 13:14:15").IsFirstOfYear() // true
// Is last day of the year
carbon.Parse("2020-12-31").IsLastOfYear() // true
carbon.Parse("2020-12-31 00:00:00").IsLastOfYear() // true
carbon.Parse("2020-12-31 13:14:15").IsLastOfYear() // true
// Is first day of the moth
carbon.Parse("2020-08-01").IsFirstOfMonth() // true
carbon.Parse("2020-08-01 00:00:00").IsFirstOfMonth() // true
carbon.Parse("2020-08-01 13:14:15").IsFirstOfMonth() // true
// Is last day of the moth
carbon.Parse("2020-08-31").IsLastOfMonth() // true
carbon.Parse("2020-08-31 00:00:00").IsLastOfMonth() // true
carbon.Parse("2020-08-31 13:14:15").IsLastOfMonth() // true
Calendar
// To year of the animal
carbon.Parse("2020-08-05 13:14:15").ToAnimalYear() // 鼠
// To lunar year
carbon.Parse("2020-08-05 13:14:15").ToLunarYear() // 庚子
// Is year of the rat
carbon.Parse("2020-08-05 13:14:15").IsYearOfRat() // true
// Is year of the ox
carbon.Parse("2020-08-05 13:14:15").IsYearOfOx() // false
// Is year of the tiger
carbon.Parse("2020-08-05 13:14:15").IsYearOfTiger() // false
// Is year of the rabbit
carbon.Parse("2020-08-05 13:14:15").IsYearOfRabbit() // false
// Is year of the dragon
carbon.Parse("2020-08-05 13:14:15").IsYearOfDragon() // false
// Is year of the snake
carbon.Parse("2020-08-05 13:14:15").IsYearOfSnake() // false
// Is year of the horse
carbon.Parse("2020-08-05 13:14:15").IsYearOfHorse() // false
// Is year of the goat
carbon.Parse("2020-08-05 13:14:15").IsYearOfGoat() // false
// Is year of the monkey
carbon.Parse("2020-08-05 13:14:15").IsYearOfMonkey() // false
// Is year of the rooster
carbon.Parse("2020-08-05 13:14:15").IsYearOfRooster() // false
// Is year of the dog
carbon.Parse("2020-08-05 13:14:15").IsYearOfDog() // false
// Is year of the dig
carbon.Parse("2020-08-05 13:14:15").IsYearOfPig() // false
ORM
Assuming the database table is users, its fields have id(int), name(varchar), age(int), graduated_at(date), birthday(date), created_at(datetime), updated_at(datetime), deleted_at(datetime)
Define the struct of model
type User struct {
ID int64 `json:"id"`
Name string `json:"name"`
Age int `json:"age"`
Birthday carbon.Carbon `json:"birthday"`
CreatedAt carbon.ToDateTimeString `json:"created_at"`
DeletedAt carbon.ToTimestamp `json:"deleted_at"`
GraduatedAt carbon.ToDateString `json:"graduated_at"`
UpdatedAt carbon.ToTimeString `json:"updated_at"`
}
Instantiate the struct of model
user := User {
Name: "勾国印",
Age: 18,
Birthday: Birthday: carbon.Now().SubYears(18),
CreatedAt: carbon.ToDateTimeString{carbon.Now()},
DeletedAt: carbon.ToTimestamp{carbon.Parse("2020-08-05 13:14:15")},
GraduatedAt: carbon.ToDateString{carbon.Parse("2012-09-09")},
UpdatedAt: carbon.ToTimeString{carbon.Now()},
}
Output built-in format
user.ID // 18
user.Name // 勾国印
user.Birthday.ToDateString() // 2012-08-05
user.CreatedAt.ToDateStartString() // 2012-08-05 00:00:00
user.DeletedAt.ToDateEndString() // 2012-08-05 23:59:59
user.GraduatedAt.AddDay().ToDateString() // 2012-09-10
user.UpdatedAt.ToDateString() // 2012-08-05
Output json format
// Output by json.Marshal(&user)
{
"id": 42,
"name": "勾国印",
"age": 18,
"birthday": "2012-08-05 00:00:00",
"created_at": "2020-08-05 13:14:15",
"deleted_at ": 1596604455
"graduated_at": "2012-09-09",
"updated_at": "13:14:15",
}
Output custom format
// Define the struct of format
type ToRssString struct {
carbon.Carbon
}
// Define the struct of model
type User struct {
Birthday ToRssString `json:"birthday"`
}
// Instantiate the struct of model
user := User {
Birthday: Birthday: ToRssString{carbon.Now()},
}
// Overload MarshalJSON method
func (c ToRssString) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, c.ToRssString())), nil
}
// Output by json.Marshal(&user)
{
"birthday": "Wed, 05 Aug 2020 13:14:15 +0800",
}
Appendix
Format sign table
| sign | desc | type | length | range | example |
|---|---|---|---|---|---|
| Y | year | number | 4 | - | 2020 |
| y | year | number | 2 | 00-99 | 20 |
| M | month | letter | 3 | Jan-Dec | Aug |
| m | month | number | 2 | 01-12 | 08 |
| F | month | letter | - | January-December | August |
| n | month | number | 1/2 | 1-12 | 8 |
| l | weekday | letter | - | Monday-Sunday | Wednesday |
| D | weekday | letter | 3 | Mon-Sun | Wed |
| d | day | number | 2 | 01-31 | 05 |
| j | day | number | 1/2 | 1-31 | 5 |
| H | hour | number | 2 | 00-23 | 15 |
| h | hour | number | 2 | 00-11 | 03 |
| i | minute | number | 2 | 01-59 | 14 |
| s | second | number | 2 | 01-59 | 15 |
| P | Ante Meridiem/Post Meridiem | letter | 2 | AM/PM | PM |
| p | ante meridiem/post meridiem | letter | 2 | am/pm | pm |