# Carbon [![Carbon Release](https://img.shields.io/github/release/golang-module/carbon.svg)](https://github.com/golang-module/carbon/releases) [![Go Test](https://github.com/golang-module/carbon/actions/workflows/test.yml/badge.svg)](https://github.com/golang-module/carbon/actions) [![Go Report Card](https://goreportcard.com/badge/github.com/golang-module/carbon)](https://goreportcard.com/report/github.com/golang-module/carbon) [![Go Coverage](https://codecov.io/gh/golang-module/carbon/branch/master/graph/badge.svg)](https://codecov.io/gh/golang-module/carbon) [![Carbon Doc](https://img.shields.io/badge/go.dev-reference-brightgreen?logo=go&logoColor=white&style=flat)](https://pkg.go.dev/github.com/golang-module/carbon) ![License](https://img.shields.io/github/license/golang-module/carbon) English | [简体中文](README.cn.md) | [日本語](README.jp.md) #### Introduction A simple, semantic and developer-friendly golang package for datetime Carbon has been included by [awesome-go](https://github.com/avelino/awesome-go#date-and-time "awesome-go"), if you think it is helpful, please give me a star [github.com/golang-module/carbon](https://github.com/golang-module/carbon "github.com/golang-module/carbon") [gitee.com/go-package/carbon](https://gitee.com/go-package/carbon "gitee.com/go-package/carbon") #### Installation ##### Go version < 1.16 ```go // 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" ) ``` ##### Go version >= 1.16 ```go // By github go get -u github.com/golang-module/carbon/v2 import ( "github.com/golang-module/carbon/v2" ) // By gitee go get -u gitee.com/go-package/carbon/v2 import ( "gitee.com/go-package/carbon/v2" ) ``` #### Usage and example > The default timezone is Local, assuming the current time is 2020-08-05 13:14:15 ##### Yesterday, today and tomorrow ```go // Return datetime of today fmt.Sprintf("%s", carbon.Now()) // 2020-08-05 13:14:15 carbon.Now().ToDateTimeString() // 2020-08-05 13:14:15 // Return date of today carbon.Now().ToDateString() // 2020-08-05 // Return time of today carbon.Now().ToTimeString() // 13:14:15 // Return datetime of today in a given timezone carbon.Now(Carbon.NewYork).ToDateTimeString() // 2020-08-05 14:14:15 // Return timestamp with second of today carbon.Now().Timestamp() // 1596604455 // Return timestamp with millisecond of today carbon.Now().TimestampMilli() // 1596604455000 // Return timestamp with microsecond of today carbon.Now().TimestampMicro() // 1596604455000000 // Return timestamp with nanosecond of today carbon.Now().TimestampNano() // 1596604455000000000 // Return datetime of yesterday fmt.Sprintf("%s", carbon.Yesterday()) // 2020-08-04 13:14:15 carbon.Yesterday().ToDateTimeString() // 2020-08-04 13:14:15 // Return date of yesterday carbon.Yesterday().ToDateString() // 2020-08-04 // Return time of yesterday carbon.Yesterday().ToTimeString() // 13:14:15 // Return datetime of yesterday on a given day carbon.Parse("2021-01-28 13:14:15").Yesterday().ToDateTimeString() // 2021-01-27 13:14:15 // Return datetime of yesterday in a given timezone carbon.Yesterday(Carbon.NewYork).ToDateTimeString() // 2020-08-04 14:14:15 // Return timestamp with second of yesterday carbon.Yesterday().Timestamp() // 1596518055 // Return timestamp with millisecond of yesterday carbon.Yesterday().TimestampMilli() // 1596518055000 // Return timestamp with microsecond of yesterday carbon.Yesterday().TimestampMicro() // 1596518055000000 // Return timestamp with nanosecond of yesterday carbon.Yesterday().TimestampNano() // 1596518055000000000 // Return datetime of tomorrow fmt.Sprintf("%s", carbon.Tomorrow()) // 2020-08-06 13:14:15 carbon.Tomorrow().ToDateTimeString() // 2020-08-06 13:14:15 // Return date of tomorrow carbon.Tomorrow().ToDateString() // 2020-08-06 // Return time of tomorrow carbon.Tomorrow().ToTimeString() // 13:14:15 // Return datetime of tomorrow on a given day carbon.Parse("2021-01-28 13:14:15").Tomorrow().ToDateTimeString() // 2021-01-29 13:14:15 // Return datetime of tomorrow in a given timezone carbon.Tomorrow(Carbon.NewYork).ToDateTimeString() // 2020-08-06 14:14:15 // Return timestamp with second of tomorrow carbon.Tomorrow().Timestamp() // 1596690855 // Return timestamp with millisecond of tomorrow carbon.Tomorrow().TimestampMilli() // 1596690855000 // Return timestamp with microsecond of tomorrow carbon.Tomorrow().TimestampMicro() // 1596690855000000 // Return timestamp with nanosecond of tomorrow carbon.Tomorrow().TimestampNano() // 1596690855000000000 ``` ##### Create a Carbon instance ```go // Create a Carbon instance from a given timestamp with second carbon.CreateFromTimestamp(-1).ToString() // 1970-01-01 07:59:59 +0800 CST carbon.CreateFromTimestamp(0).ToString() // 1970-01-01 08:00:00 +0800 CST carbon.CreateFromTimestamp(1).ToString() // 1970-01-01 08:00:01 +0800 CST carbon.CreateFromTimestamp(1649735755).ToString() // 2022-04-12 11:55:55 +0800 CST // Create a Carbon instance from a given timestamp with millisecond carbon.CreateFromTimestampMilli(1649735755981).ToString() // 2022-04-12 11:55:55.981 +0800 CST // Create a Carbon instance from a given timestamp with microsecond carbon.CreateFromTimestampMicro(1649735755981566).ToString() // 2022-04-12 11:55:55.981566 +0800 CST // Create a Carbon instance from a given timestamp with nanosecond carbon.CreateFromTimestampNano(1649735755981566000).ToString() // 2022-04-12 11:55:55.981566 +0800 CST // Create a Carbon instance from a given date and time. carbon.CreateFromDateTime(2020, 8, 5, 13, 14, 15).ToDateTimeString() // 2020-08-05 13:14:15 // Create a Carbon instance from a given date and time with millisecond. carbon.CreateFromDateTimeMilli(2020, 1, 1, 13, 14, 15, 999).ToString() // 2020-01-01 13:14:15.999 +0800 CST // Create a Carbon instance from a given date and time with microsecond. carbon.CreateFromDateTimeMicro(2020, 1, 1, 13, 14, 15, 999999).ToString() // 2020-01-01 13:14:15.999999 +0800 CST // Create a Carbon instance from a given date and time with nanosecond. carbon.CreateFromDateTimeNano(2020, 1, 1, 13, 14, 15, 999999999).ToString() // 2020-01-01 13:14:15.999999999 +0800 CST // Create a Carbon instance from a given year, month and day carbon.CreateFromDate(2020, 8, 5).ToDateTimeString() // 2020-08-05 13:14:15 // Create a Carbon instance from a given hour, minute and second carbon.CreateFromTime(13, 14, 15).ToDateTimeString() // 2020-08-05 13:14:15 ``` ##### Parse a standard string as a Carbon instance ```go carbon.Parse("").ToDateTimeString() // empty string carbon.Parse("0").ToDateTimeString() // empty string carbon.Parse("0000-00-00 00:00:00").ToDateTimeString() // empty string carbon.Parse("0000-00-00").ToDateTimeString() // empty string carbon.Parse("00:00:00").ToDateTimeString() // empty string carbon.Parse("2020-08-05").ToString() // 2020-08-05 00:00:00 +0800 CST carbon.Parse("2020-08-05 13:14:15").ToString() // 2020-08-05 13:14:15 +0800 CST carbon.Parse("2020-08-05 13:14:15.999").ToString() // 2020-08-05 13:14:15.999 +0800 CST carbon.Parse("2020-08-05 13:14:15.999999").ToString() // 2020-08-05 13:14:15.999999 +0800 CST carbon.Parse("2020-08-05 13:14:15.999999999").ToString() // 2020-08-05 13:14:15.999999999 +0800 CST carbon.Parse("2020-08-05T13:14:15+08:00").ToString() // 2020-08-05 13:14:15 +0800 CST carbon.Parse("2020-08-05T13:14:15.999+08:00").ToString() // 2020-08-05 13:14:15.999 +0800 CST carbon.Parse("2020-08-05T13:14:15.999999+08:00").ToString() // 2020-08-05 13:14:15.999999 +0800 CST carbon.Parse("2020-08-05T13:14:15.999999999+08:00").ToString() // 2020-08-05 13:14:15.999999999 +0800 CST carbon.Parse("20200805").ToString() // 2020-08-05 00:00:00 +0800 CST carbon.Parse("20200805131415").ToString() // 2020-08-05 13:14:15 +0800 CST carbon.Parse("20200805131415.999").ToString() // 2020-08-05 13:14:15.999 +0800 CST carbon.Parse("20200805131415.999999").ToString() // 2020-08-05 13:14:15.999999 +0800 CST carbon.Parse("20200805131415.999999999").ToString() // 2020-08-05 13:14:15.999999999 +0800 CST ``` ##### Parse a string as a Carbon instance by format ```go carbon.ParseByFormat("2020|08|05 13|14|15", "Y|m|d H|i|s").ToDateTimeString() // 2020-08-05 13:14:15 carbon.ParseByFormat("It is 2020-08-05 13:14:15", "\\I\\t \\i\\s 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秒").ToDateTimeString() // 2020-08-05 13:14:15 ``` ##### Parse a string as a Carbon instance by layout ```go carbon.ParseByLayout("2020|08|05 13|14|15", "2006|01|02 15|04|05").ToDateTimeString() // 2020-08-05 13:14:15 carbon.ParseByLayout("It is 2020-08-05 13:14:15", "It is 2006-01-02 15:04:05").ToDateTimeString() // 2020-08-05 13:14:15 carbon.ParseByLayout("今天是 2020年08月05日13时14分15秒", "今天是 2006年01月02日15时04分05秒").ToDateTimeString() // 2020-08-05 13:14:15 ``` ##### Convert between Carbon and Time ```go // Convert Time.time into Carbon carbon.Time2Carbon(time.Now()) // Convert Carbon into Time.time carbon.Now().Carbon2Time() ``` ##### Start and end ```go // Start of the century carbon.Parse("2020-08-05 13:14:15").StartOfCentury().ToDateTimeString() // 2000-01-01 00:00:00 // End of the century carbon.Parse("2020-08-05 13:14:15").EndOfCentury().ToDateTimeString() // 2999-12-31 23:59:59 // Start of the decade carbon.Parse("2020-08-05 13:14:15").StartOfDecade().ToDateTimeString() // 2020-01-01 00:00:00 carbon.Parse("2021-08-05 13:14:15").StartOfDecade().ToDateTimeString() // 2020-01-01 00:00:00 carbon.Parse("2029-08-05 13:14:15").StartOfDecade().ToDateTimeString() // 2020-01-01 00:00:00 // End of the decade carbon.Parse("2020-08-05 13:14:15").EndOfDecade().ToDateTimeString() // 2029-12-31 23:59:59 carbon.Parse("2021-08-05 13:14:15").EndOfDecade().ToDateTimeString() // 2029-12-31 23:59:59 carbon.Parse("2029-08-05 13:14:15").EndOfDecade().ToDateTimeString() // 2029-12-31 23:59:59 // Start of the year carbon.Parse("2020-08-05 13:14:15").StartOfYear().ToDateTimeString() // 2020-01-01 00:00:00 // End of the year carbon.Parse("2020-08-05 13:14:15").EndOfYear().ToDateTimeString() // 2020-12-31 23:59:59 // Start of the quarter carbon.Parse("2020-08-05 13:14:15").StartOfQuarter().ToDateTimeString() // 2020-07-01 00:00:00 // End of the quarter carbon.Parse("2020-08-05 13:14:15").EndOfQuarter().ToDateTimeString() // 2020-09-30 23:59:59 // Start of the month carbon.Parse("2020-08-05 13:14:15").StartOfMonth().ToStartTimeString() // 2020-08-01 00:00:00 // End of the month carbon.Parse("2020-08-05 13:14:15").EndOfMonth().ToDateTimeString() // 2020-08-31 23:59:59 // Start of the week carbon.Parse("2020-08-05 13:14:15").StartOfWeek().ToDateTimeString() // 2020-08-02 00:00:00 carbon.Parse("2020-08-05 13:14:15").SetWeekStartsAt(carbon.Sunday).StartOfWeek().ToDateTimeString() // 2020-08-02 00:00:00 carbon.Parse("2020-08-05 13:14:15").SetWeekStartsAt(carbon.Monday).StartOfWeek().ToDateTimeString() // 2020-08-03 00:00:00 // End of the week carbon.Parse("2020-08-05 13:14:15").EndOfWeek().ToDateTimeString() // 2020-08-08 23:59:59 carbon.Parse("2020-08-05 13:14:15").SetWeekStartsAt(carbon.Sunday).EndOfWeek().ToDateTimeString() // 2020-08-08 23:59:59 carbon.Parse("2020-08-05 13:14:15").SetWeekStartsAt(carbon.Monday).EndOfWeek().ToDateTimeString() // 2020-08-09 23:59:59 // Start of the day carbon.Parse("2020-08-05 13:14:15").StartOfDay().ToDateTimeString() // 2020-08-05 00:00:00 // End of the day carbon.Parse("2020-08-05 13:14:15").EndOfDay().ToDateTimeString() // 2020-08-05 23:59:59 // Start of the hour carbon.Parse("2020-08-05 13:14:15").StartOfHour().ToDateTimeString() // 2020-08-05 13:00:00 // End of the hour carbon.Parse("2020-08-05 13:14:15").EndOfHour().ToDateTimeString() // 2020-08-05 13:59:59 // Start of the minute carbon.Parse("2020-08-05 13:14:15").StartOfMinute().ToDateTimeString() // 2020-08-05 13:14:00 // End of the minute carbon.Parse("2020-08-05 13:14:15").EndOfMinute().ToDateTimeString() // 2020-08-05 13:14:59 // Start of the second carbon.Parse("2020-08-05 13:14:15").StartOfSecond().ToString() // 2020-08-05 13:14:15 +0800 CST // End of the second carbon.Parse("2020-08-05 13:14:15").EndOfSecond().ToString() // 2020-08-05 13:14:15.999999999 +0800 CST ``` ##### Addition and subtraction ```go // Add three centuries carbon.Parse("2020-02-29 13:14:15").AddCenturies(3).ToDateTimeString() // 2320-02-29 13:14:15 // Add three centuries without overflowing month carbon.Parse("2020-02-29 13:14:15").AddCenturiesNoOverflow(3).ToDateTimeString() // 2320-02-29 13:14:15 // Add one century carbon.Parse("2020-02-29 13:14:15").AddCentury().ToDateTimeString() // 2120-02-29 13:14:15 // Add one century without overflowing month carbon.Parse("2020-02-29 13:14:15").AddCenturyNoOverflow().ToDateTimeString() // 2120-02-29 13:14:15 // Subtract three centuries carbon.Parse("2020-02-29 13:14:15").SubCenturies(3).ToDateTimeString() // 1720-02-29 13:14:15 // Subtract three centuries without overflowing month carbon.Parse("2020-02-29 13:14:15").SubCenturiesNoOverflow(3).ToDateTimeString() // 1720-02-29 13:14:15 // Subtract one century carbon.Parse("2020-02-29 13:14:15").SubCentury().ToDateTimeString() // 1920-02-29 13:14:15 // Subtract one century without overflowing month carbon.Parse("2020-02-29 13:14:15").SubCenturyNoOverflow().ToDateTimeString() // 1920-02-20 13:14:15 // Add three decades carbon.Parse("2020-02-29 13:14:15").AddDecades(3).ToDateTimeString() // 2050-03-01 13:14:15 // Add three decades without overflowing month carbon.Parse("2020-02-29 13:14:15").AddDecadesNoOverflow(3).ToDateTimeString() // 2050-02-28 13:14:15 // Add one decade carbon.Parse("2020-02-29 13:14:15").AddDecade().ToDateTimeString() // 2030-03-01 13:14:15 // Add one decade without overflowing month carbon.Parse("2020-02-29 13:14:15").AddDecadeNoOverflow().ToDateTimeString() // 2030-02-28 13:14:15 // Subtract three decades carbon.Parse("2020-02-29 13:14:15").SubDecades(3).ToDateTimeString() // 1990-03-01 13:14:15 // Subtract three decades without overflowing month carbon.Parse("2020-02-29 13:14:15").SubDecadesNoOverflow(3).ToDateTimeString() // 1990-02-28 13:14:15 // Subtract one decade carbon.Parse("2020-02-29 13:14:15").SubDecade().ToDateTimeString() // 2010-03-01 13:14:15 // Subtract one decade without overflowing month carbon.Parse("2020-02-29 13:14:15").SubDecadeNoOverflow().ToDateTimeString() // 2010-02-28 13:14:15 // Add three years carbon.Parse("2020-02-29 13:14:15").AddYears(3).ToDateTimeString() // 2023-03-01 13:14:15 // Add three years without overflowing month carbon.Parse("2020-02-29 13:14:15").AddYearsNoOverflow(3).ToDateTimeString() // 2023-02-28 13:14:15 // Add one year carbon.Parse("2020-02-29 13:14:15").AddYear().ToDateTimeString() // 2021-03-01 13:14:15 // Add one year without overflowing month carbon.Parse("2020-02-29 13:14:15").AddYearNoOverflow().ToDateTimeString() // 2021-02-28 13:14:15 // Subtract three years carbon.Parse("2020-02-29 13:14:15").SubYears(3).ToDateTimeString() // 2017-03-01 13:14:15 // Subtract three years without overflowing month carbon.Parse("2020-02-29 13:14:15").SubYearsNoOverflow(3).ToDateTimeString() // 2017-02-28 13:14:15 // Subtract one year carbon.Parse("2020-02-29 13:14:15").SubYear().ToDateTimeString() // 2019-03-01 13:14:15 // Subtract one year without overflowing month carbon.Parse("2020-02-29 13:14:15").SubYearNoOverflow().ToDateTimeString() // 2019-02-28 13:14:15 // Add three quarters carbon.Parse("2019-08-31 13:14:15").AddQuarters(3).ToDateTimeString() // 2019-03-02 13:14:15 // Add three quarters without overflowing month carbon.Parse("2019-08-31 13:14:15").AddQuartersNoOverflow(3).ToDateTimeString() // 2019-02-29 13:14:15 // Add one quarter carbon.Parse("2019-11-30 13:14:15").AddQuarter().ToDateTimeString() // 2020-03-01 13:14:15 // Add one quarter without overflowing month carbon.Parse("2019-11-30 13:14:15").AddQuarterNoOverflow().ToDateTimeString() // 2020-02-29 13:14:15 // Subtract three quarters carbon.Parse("2019-08-31 13:14:15").SubQuarters(3).ToDateTimeString() // 2019-03-03 13:14:15 // Subtract three quarters without overflowing month carbon.Parse("2019-08-31 13:14:15").SubQuartersNoOverflow(3).ToDateTimeString() // 2019-02-28 13:14:15 // Subtract one quarter carbon.Parse("2020-05-31 13:14:15").SubQuarter().ToDateTimeString() // 2020-03-02 13:14:15 // Subtract one quarter without overflowing month carbon.Parse("2020-05-31 13:14:15").SubQuarterNoOverflow().ToDateTimeString() // 2020-02-29 13:14:15 // Add three months carbon.Parse("2020-02-29 13:14:15").AddMonths(3).ToDateTimeString() // 2020-05-29 13:14:15 // Add three months without overflowing month carbon.Parse("2020-02-29 13:14:15").AddMonthsNoOverflow(3).ToDateTimeString() // 2020-05-29 13:14:15 // Add one month carbon.Parse("2020-01-31 13:14:15").AddMonth().ToDateTimeString() // 2020-03-02 13:14:15 // Add one month without overflowing month carbon.Parse("2020-01-31 13:14:15").AddMonthNoOverflow().ToDateTimeString() // 2020-02-29 13:14:15 // Subtract three months carbon.Parse("2020-02-29 13:14:15").SubMonths(3).ToDateTimeString() // 2019-11-29 13:14:15 // Subtract three months without overflowing month carbon.Parse("2020-02-29 13:14:15").SubMonthsNoOverflow(3).ToDateTimeString() // 2019-11-29 13:14:15 // Subtract one month carbon.Parse("2020-03-31 13:14:15").SubMonth().ToDateTimeString() // 2020-03-02 13:14:15 // Subtract one month without overflowing month carbon.Parse("2020-03-31 13:14:15").SubMonthNoOverflow().ToDateTimeString() // 2020-02-29 13:14:15 // Add three weeks carbon.Parse("2020-02-29 13:14:15").AddWeeks(3).ToDateTimeString() // 2020-03-21 13:14:15 // Add one week carbon.Parse("2020-02-29 13:14:15").AddWeek().ToDateTimeString() // 2020-03-07 13:14:15 // Subtract three weeks carbon.Parse("2020-02-29 13:14:15").SubWeeks(3).ToDateTimeString() // 2020-02-08 13:14:15 // Subtract three week carbon.Parse("2020-02-29 13:14:15").SubWeek().ToDateTimeString() // 2020-02-22 13:14:15 // Add three days carbon.Parse("2020-08-05 13:14:15").AddDays(3).ToDateTimeString() // 2020-08-08 13:14:15 // Add one day carbon.Parse("2020-08-05 13:14:15").AddDay().ToDateTimeString() // 2020-08-05 13:14:15 // Subtract three days carbon.Parse("2020-08-05 13:14:15").SubDays(3).ToDateTimeString() // 2020-08-02 13:14:15 // Subtract one day carbon.Parse("2020-08-05 13:14:15").SubDay().ToDateTimeString() // 2020-08-04 13:14:15 // Add three hours carbon.Parse("2020-08-05 13:14:15").AddHours(3).ToDateTimeString() // 2020-08-05 16:14:15 // Add two and a half hours carbon.Parse("2020-08-05 13:14:15").AddDuration("2.5h").ToDateTimeString() // 2020-08-05 15:44:15 carbon.Parse("2020-08-05 13:14:15").AddDuration("2h30m").ToDateTimeString() // 2020-08-05 15:44:15 // Add one hour carbon.Parse("2020-08-05 13:14:15").AddHour().ToDateTimeString() // 2020-08-05 14:14:15 // Subtract three hours carbon.Parse("2020-08-05 13:14:15").SubHours(3).ToDateTimeString() // 2020-08-05 10:14:15 // Subtract two and a half hours carbon.Parse("2020-08-05 13:14:15").SubDuration("2.5h").ToDateTimeString() // 2020-08-05 10:44:15 carbon.Parse("2020-08-05 13:14:15").SubDuration("2h30m").ToDateTimeString() // 2020-08-05 10:44:15 // Subtract one hour carbon.Parse("2020-08-05 13:14:15").SubHour().ToDateTimeString() // 2020-08-05 12:14:15 // Add three minutes carbon.Parse("2020-08-05 13:14:15").AddMinutes(3).ToDateTimeString() // 2020-08-05 13:17:15 // Add two and a half minutes carbon.Parse("2020-08-05 13:14:15").AddDuration("2.5m").ToDateTimeString() // 2020-08-05 13:16:45 carbon.Parse("2020-08-05 13:14:15").AddDuration("2m30s").ToDateTimeString() // 2020-08-05 13:16:45 // Add one minute carbon.Parse("2020-08-05 13:14:15").AddMinute().ToDateTimeString() // 2020-08-05 13:15:15 // Subtract three minutes carbon.Parse("2020-08-05 13:14:15").SubMinutes(3).ToDateTimeString() // 2020-08-05 13:11:15 // Subtract two and a half minutes carbon.Parse("2020-08-05 13:14:15").SubDuration("2.5m").ToDateTimeString() // 2020-08-05 13:11:45 // Subtract one minute carbon.Parse("2020-08-05 13:14:15").SubMinute().ToDateTimeString() // 2020-08-05 13:13:15 // Add three seconds carbon.Parse("2020-08-05 13:14:15").AddSeconds(3).ToDateTimeString() // 2020-08-05 13:14:18 // Add two and a half seconds carbon.Parse("2020-08-05 13:14:15").AddDuration("2.5s").ToDateTimeString() // 2020-08-05 13:14:17 // Add one second carbon.Parse("2020-08-05 13:14:15").AddSecond().ToDateTimeString() // 2020-08-05 13:14:16 // Subtract three seconds carbon.Parse("2020-08-05 13:14:15").SubSeconds(3).ToDateTimeString() // 2020-08-05 13:14:12 // Subtract two and a half seconds carbon.Parse("2020-08-05 13:14:15").SubDuration("2.5s").ToDateTimeString() // 2020-08-05 13:14:12 // Subtract one second carbon.Parse("2020-08-05 13:14:15").SubSecond().ToDateTimeString() // 2020-08-05 13:14:14 ``` ##### Difference ```go // Difference in years carbon.Parse("2021-08-05 13:14:15").DiffInYears(carbon.Parse("2020-08-05 13:14:15")) // -1 // Difference in years with absolute value carbon.Parse("2021-08-05 13:14:15").DiffAbsInYears(carbon.Parse("2020-08-05 13:14:15")) // 1 // Difference in months carbon.Parse("2020-08-05 13:14:15").DiffInMonths(carbon.Parse("2020-07-05 13:14:15")) // -1 // Difference in months with absolute value carbon.Parse("2020-08-05 13:14:15").DiffAbsInMonths(carbon.Parse("2020-07-05 13:14:15")) // 1 // Difference in weeks carbon.Parse("2020-08-05 13:14:15").DiffInWeeks(carbon.Parse("2020-07-28 13:14:15")) // -1 // Difference in weeks with absolute value carbon.Parse("2020-08-05 13:14:15").DiffAbsInWeeks(carbon.Parse("2020-07-28 13:14:15")) // 1 // Difference in days carbon.Parse("2020-08-05 13:14:15").DiffInDays(carbon.Parse("2020-08-04 13:14:15")) // -1 // Difference in days with absolute value carbon.Parse("2020-08-05 13:14:15").DiffAbsInDays(carbon.Parse("2020-08-04 13:14:15")) // 1 // Difference in hours carbon.Parse("2020-08-05 13:14:15").DiffInHours(carbon.Parse("2020-08-05 12:14:15")) // -1 // Difference in hours with absolute value carbon.Parse("2020-08-05 13:14:15").DiffAbsInHours(carbon.Parse("2020-08-05 12:14:15")) // 1 // Difference in minutes carbon.Parse("2020-08-05 13:14:15").DiffInMinutes(carbon.Parse("2020-08-05 13:13:15")) // -1 // Difference in minutes with absolute value carbon.Parse("2020-08-05 13:14:15").DiffAbsInMinutes(carbon.Parse("2020-08-05 13:13:15")) // 1 // Difference in seconds carbon.Parse("2020-08-05 13:14:15").DiffInSeconds(carbon.Parse("2020-08-05 13:14:14")) // -1 // Difference in seconds with absolute value carbon.Parse("2020-08-05 13:14:15").DiffAbsInSeconds(carbon.Parse("2020-08-05 13:14:14")) // 1 // Difference in string carbon.Now().DiffInString() // just now carbon.Now().AddYearsNoOverflow(1).DiffInString() // -1 year carbon.Now().SubYearsNoOverflow(1).DiffInString() // 1 year // Difference in string with absolute value carbon.Now().DiffAbsInString(carbon.Now()) // just now carbon.Now().AddYearsNoOverflow(1).DiffAbsInString(carbon.Now()) // 1 year carbon.Now().SubYearsNoOverflow(1).DiffAbsInString(carbon.Now()) // 1 year // Difference in a human-readable format carbon.Parse("2020-08-05 13:14:15").DiffForHumans() // just now carbon.Parse("2019-08-05 13:14:15").DiffForHumans() // 1 year ago carbon.Parse("2018-08-05 13:14:15").DiffForHumans() // 2 years ago carbon.Parse("2021-08-05 13:14:15").DiffForHumans() // 1 year from now carbon.Parse("2022-08-05 13:14:15").DiffForHumans() // 2 years from now // Difference in a human-readable format from now time carbon.Parse("2020-08-05 13:14:15").DiffForHumans(carbon.Now()) // 1 year before carbon.Parse("2019-08-05 13:14:15").DiffForHumans(carbon.Now()) // 2 years before carbon.Parse("2018-08-05 13:14:15").DiffForHumans(carbon.Now()) // 1 year after carbon.Parse("2022-08-05 13:14:15").DiffForHumans(carbon.Now()) // 2 years after ``` ##### Comparison ```go // Whether is zero time carbon.Parse("").IsZero() // true carbon.Parse("0").IsZero() // true carbon.Parse("0000-00-00 00:00:00").IsZero() // true carbon.Parse("0000-00-00").IsZero() // true carbon.Parse("00:00:00").IsZero() // true carbon.Parse("2020-08-05 00:00:00").IsZero() // false carbon.Parse("2020-08-05").IsZero() // false carbon.Parse("2020-08-05").SetTimezone("xxx").IsZero() // false // Whether is invalid time carbon.Parse("").IsInvalid() // true carbon.Parse("0").IsInvalid() // true carbon.Parse("0000-00-00 00:00:00").IsInvalid() // true carbon.Parse("0000-00-00").IsInvalid() // true carbon.Parse("00:00:00").IsInvalid() // true carbon.Parse("2020-08-05 00:00:00").IsInvalid() // false carbon.Parse("2020-08-05").IsInvalid() // false carbon.Parse("2020-08-05").SetTimezone("xxx").IsInvalid() // true // Whether is now time carbon.Now().IsNow() // true // Whether is future time carbon.Tomorrow().IsFuture() // true // Whether is pass time carbon.Yesterday().IsPast() // true // Whether is a leap year carbon.Parse("2020-08-05 13:14:15").IsLeapYear() // true // Whether is a long year carbon.Parse("2020-08-05 13:14:15").IsLongYear() // true // Whether is January carbon.Parse("2020-08-05 13:14:15").IsJanuary() // false // Whether is February carbon.Parse("2020-08-05 13:14:15").IsFebruary() // false // Whether is March carbon.Parse("2020-08-05 13:14:15").IsMarch() // false // Whether is April carbon.Parse("2020-08-05 13:14:15").IsApril() // false // Whether is May carbon.Parse("2020-08-05 13:14:15").IsMay() // false // Whether is June carbon.Parse("2020-08-05 13:14:15").IsJune() // false // Whether is July carbon.Parse("2020-08-05 13:14:15").IsJuly() // false // Whether is August carbon.Parse("2020-08-05 13:14:15").IsAugust() // false // Whether is September carbon.Parse("2020-08-05 13:14:15").IsSeptember() // true // Whether is October carbon.Parse("2020-08-05 13:14:15").IsOctober() // false // Whether is November carbon.Parse("2020-08-05 13:14:15").IsNovember() // false // Whether is December carbon.Parse("2020-08-05 13:14:15").IsDecember() // false // Whether is Monday carbon.Parse("2020-08-05 13:14:15").IsMonday() // false // Whether is Tuesday carbon.Parse("2020-08-05 13:14:15").IsTuesday() // true // Whether is Wednesday carbon.Parse("2020-08-05 13:14:15").IsWednesday() // false // Whether is Thursday carbon.Parse("2020-08-05 13:14:15").IsThursday() // false // Whether is Friday carbon.Parse("2020-08-05 13:14:15").IsFriday() // false // Whether is Saturday carbon.Parse("2020-08-05 13:14:15").IsSaturday() // false // Whether is Sunday carbon.Parse("2020-08-05 13:14:15").IsSunday() // false // Whether is weekday carbon.Parse("2020-08-05 13:14:15").IsWeekday() // false // Whether is weekend carbon.Parse("2020-08-05 13:14:15").IsWeekend() // true // Whether 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 // Whether 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 // Whether 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 // Whether greater than carbon.Parse("2020-08-05 13:14:15").Gt(carbon.Parse("2020-08-04 13:14:15")) // true carbon.Parse("2020-08-05 13:14:15").Gt(carbon.Parse("2020-08-05 13:14:15")) // false carbon.Parse("2020-08-05 13:14:15").Compare(">", carbon.Parse("2020-08-04 13:14:15")) // true carbon.Parse("2020-08-05 13:14:15").Compare(">", carbon.Parse("2020-08-05 13:14:15")) // false // Whether less than carbon.Parse("2020-08-05 13:14:15").Lt(carbon.Parse("2020-08-06 13:14:15")) // true carbon.Parse("2020-08-05 13:14:15").Lt(carbon.Parse("2020-08-05 13:14:15")) // false carbon.Parse("2020-08-05 13:14:15").Compare("<", carbon.Parse("2020-08-06 13:14:15")) // true carbon.Parse("2020-08-05 13:14:15").Compare("<", carbon.Parse("2020-08-05 13:14:15")) // false // Whether equal carbon.Parse("2020-08-05 13:14:15").Eq(carbon.Parse("2020-08-05 13:14:15")) // true carbon.Parse("2020-08-05 13:14:15").Eq(carbon.Parse("2020-08-05 13:14:00")) // false carbon.Parse("2020-08-05 13:14:15").Compare("=", carbon.Parse("2020-08-05 13:14:15")) // true carbon.Parse("2020-08-05 13:14:15").Compare("=", carbon.Parse("2020-08-05 13:14:00")) // false // Whether not equal carbon.Parse("2020-08-05 13:14:15").Ne(carbon.Parse("2020-08-06 13:14:15")) // true carbon.Parse("2020-08-05 13:14:15").Ne(carbon.Parse("2020-08-05 13:14:15")) // false carbon.Parse("2020-08-05 13:14:15").Compare("!=", carbon.Parse("2020-08-06 13:14:15")) // true carbon.Parse("2020-08-05 13:14:15").Compare("<>", carbon.Parse("2020-08-05 13:14:15")) // false // Whether greater than or equal carbon.Parse("2020-08-05 13:14:15").Gte(carbon.Parse("2020-08-04 13:14:15")) // true carbon.Parse("2020-08-05 13:14:15").Gte(carbon.Parse("2020-08-05 13:14:15")) // true carbon.Parse("2020-08-05 13:14:15").Compare(">=", carbon.Parse("2020-08-04 13:14:15")) // true carbon.Parse("2020-08-05 13:14:15").Compare(">=", carbon.Parse("2020-08-05 13:14:15")) // true // Whether less than or equal carbon.Parse("2020-08-05 13:14:15").Lte(carbon.Parse("2020-08-06 13:14:15")) // true carbon.Parse("2020-08-05 13:14:15").Lte(carbon.Parse("2020-08-05 13:14:15")) // true carbon.Parse("2020-08-05 13:14:15").Compare("<=", carbon.Parse("2020-08-06 13:14:15")) // true carbon.Parse("2020-08-05 13:14:15").Compare("<=", carbon.Parse("2020-08-05 13:14:15")) // true // Whether between two Carbon instances, excluded the start and end Carbon instance carbon.Parse("2020-08-05 13:14:15").Between(carbon.Parse("2020-08-05 13:14:15"), carbon.Parse("2020-08-06 13:14:15")) // false carbon.Parse("2020-08-05 13:14:15").Between(carbon.Parse("2020-08-04 13:14:15"), carbon.Parse("2020-08-06 13:14:15")) // true // Whether between two Carbon instances, included the start Carbon instance carbon.Parse("2020-08-05 13:14:15").BetweenIncludedStart(carbon.Parse("2020-08-05 13:14:15"), carbon.Parse("2020-08-06 13:14:15")) // true carbon.Parse("2020-08-05 13:14:15").BetweenIncludedStart(carbon.Parse("2020-08-04 13:14:15"), carbon.Parse("2020-08-06 13:14:15")) // true // Whether between two Carbon instances, included the end Carbon instance carbon.Parse("2020-08-05 13:14:15").BetweenIncludedEnd(carbon.Parse("2020-08-04 13:14:15"), carbon.Parse("2020-08-05 13:14:15")) // true carbon.Parse("2020-08-05 13:14:15").BetweenIncludedEnd(carbon.Parse("2020-08-04 13:14:15"), carbon.Parse("2020-08-06 13:14:15")) // true // Whether between two Carbon instances, included the start and end Carbon instance carbon.Parse("2020-08-05 13:14:15").BetweenIncludedBoth(carbon.Parse("2020-08-05 13:14:15"), carbon.Parse("2020-08-06 13:14:15")) // true carbon.Parse("2020-08-05 13:14:15").BetweenIncludedBoth(carbon.Parse("2020-08-04 13:14:15"), carbon.Parse("2020-08-05 13:14:15")) // true ``` > For the definition of long year, please see https://en.wikipedia.org/wiki/ISO_8601#Week_dates ##### Setter ```go // Set timezone carbon.SetTimezone(carbon.PRC).Now().ToDateTimeString() // 2020-08-05 13:14:15 carbon.SetTimezone(carbon.Tokyo).Now().ToDateTimeString() // 2020-08-05 14:14:15 carbon.SetTimezone(carbon.Tokyo).Now().SetTimezone(carbon.PRC).ToDateTimeString() // 2020-08-05 12:14:15 // Set locale carbon.Parse("2020-07-05 13:14:15").SetLocale("en").DiffForHumans() // 1 month before carbon.Parse("2020-07-05 13:14:15").SetLocale("zh-CN").DiffForHumans() // 1 月前 // Set year, month, day, hour, minute and second. carbon.Parse("2020-01-01").SetDateTime(2019, 2, 2, 13, 14, 15).ToString() // 2019-02-02 13:14:15 +0800 CST carbon.Parse("2020-01-01").SetDateTime(2019, 2, 31, 13, 14, 15).ToString() // 2019-03-03 13:14:15 +0800 CST // Set year, month, day, hour, minute and second with millisecond. carbon.Parse("2020-01-01").SetDateTimeMilli(2019, 2, 2, 13, 14, 15, 999).ToString() // 2019-02-02 13:14:15.999 +0800 CST carbon.Parse("2020-01-01").SetDateTimeMilli(2019, 2, 31, 13, 14, 15, 999).ToString() // 2019-03-03 13:14:15.999 +0800 CST // Set year, month, day, hour, minute and second with microsecond. carbon.Parse("2020-01-01").SetDateTimeMicro(2019, 2, 2, 13, 14, 15, 999999).ToString() // 2019-02-02 13:14:15.999999 +0800 CST carbon.Parse("2020-01-01").SetDateTimeMicro(2019, 2, 31, 13, 14, 15, 999999).ToString() // 2019-03-03 13:14:15.999999 +0800 CST // Set year, month, day, hour, minute and second with nanosecond. carbon.Parse("2020-01-01").SetDateTimeNano(2019, 2, 2, 13, 14, 15, 999999999).ToString() // 2019-02-02 13:14:15.999999999 +0800 CST carbon.Parse("2020-01-01").SetDateTimeNano(2019, 2, 31, 13, 14, 15, 999999999).ToString() // 2019-03-03 13:14:15.999999999 +0800 CST // Set year, month and day. carbon.Parse("2020-01-01").SetDate(2019, 2, 2).ToDateTimeString() // 2019-02-02 00:00:00 carbon.Parse("2020-01-01").SetDate(2019, 2, 31).ToDateTimeString() // 2019-03-03 00:00:00 // Set hour, minute and second. carbon.Parse("2020-01-01").SetTime(13, 14, 15).ToDateTimeString() // 2020-01-01 13:14:15 carbon.Parse("2020-01-01").SetTime(13, 14, 90).ToDateTimeString() // 2020-01-01 13:15:30 // Set year carbon.Parse("2020-02-29").SetYear(2021).ToDateString() // 2021-03-01 // Set year without overflowing month carbon.Parse("2020-02-29").SetYearNoOverflow(2021).ToDateString() // 2021-02-28 // Set month carbon.Parse("2020-01-31").SetMonth(2).ToDateString() // 2020-03-02 // Set month without overflowing month carbon.Parse("2020-01-31").SetMonthNoOverflow(2).ToDateString() // 2020-02-29 // Set start day of the week carbon.Parse("2020-08-02").SetWeekStartsAt(carbon.Sunday).Week() // 0 carbon.Parse("2020-08-02").SetWeekStartsAt(carbon.Monday).Week() // 6 // Set day carbon.Parse("2019-08-05").SetDay(31).ToDateString() // 2020-08-31 carbon.Parse("2020-02-01").SetDay(31).ToDateString() // 2020-03-02 // Set hour carbon.Parse("2020-08-05 13:14:15").SetHour(10).ToDateTimeString() // 2020-08-05 10:14:15 carbon.Parse("2020-08-05 13:14:15").SetHour(24).ToDateTimeString() // 2020-08-06 00:14:15 // Set minute carbon.Parse("2020-08-05 13:14:15").SetMinute(10).ToDateTimeString() // 2020-08-05 13:10:15 carbon.Parse("2020-08-05 13:14:15").SetMinute(60).ToDateTimeString() // 2020-08-05 14:00:15 // Set second carbon.Parse("2020-08-05 13:14:15").SetSecond(10).ToDateTimeString() // 2020-08-05 13:14:10 carbon.Parse("2020-08-05 13:14:15").SetSecond(60).ToDateTimeString() // 2020-08-05 13:15:00 // Set millisecond carbon.Parse("2020-08-05 13:14:15").SetMillisecond(100).Millisecond() // 100 carbon.Parse("2020-08-05 13:14:15").SetMillisecond(999).Millisecond() // 999 // Set microsecond carbon.Parse("2020-08-05 13:14:15").SetMicrosecond(100000).Microsecond() // 100000 carbon.Parse("2020-08-05 13:14:15").SetMicrosecond(999999).Microsecond() // 999999 // Set nanosecond carbon.Parse("2020-08-05 13:14:15").SetNanosecond(100000000).Nanosecond() // 100000000 carbon.Parse("2020-08-05 13:14:15").SetNanosecond(999999999).Nanosecond() // 999999999 ``` ##### Getter ```go // Get total days of the year carbon.Parse("2019-08-05 13:14:15").DaysInYear() // 365 carbon.Parse("2020-08-05 13:14:15").DaysInYear() // 366 // Get total days of the month carbon.Parse("2020-02-01 13:14:15").DaysInMonth() // 29 carbon.Parse("2020-04-01 13:14:15").DaysInMonth() // 30 carbon.Parse("2020-08-01 13:14:15").DaysInMonth() // 31 // Get day of the year carbon.Parse("2020-08-05 13:14:15").DayOfYear() // 218 // Get week of the year carbon.Parse("2020-08-05 13:14:15").WeekOfYear() // 32 // Get day of the month carbon.Parse("2020-08-05 13:14:15").DayOfMonth() // 5 // Get week of the month carbon.Parse("2020-08-05 13:14:15").WeekOfMonth() // 1 // Get day of the week carbon.Parse("2020-08-05 13:14:15").DayOfWeek() // 3 // Get current year, month, day, hour, minute and second carbon.Parse("2020-08-05 13:14:15").DateTime() // 2020,8,5,13,14,15 // Get current year, month, day, hour, minute, second and millisecond carbon.Parse("2020-08-05 13:14:15").DateTimeMilli() // 2020,8,5,13,14,15,999 // Get current year, month, day, hour, minute, second and microsecond carbon.Parse("2020-08-05 13:14:15").DateTimeMicro() // 2020,8,5,13,14,15,999999 //Get current year, month, day, hour, minute, second and nanosecond carbon.Parse("2020-08-05 13:14:15").DateTimeNano() // 2020,8,5,13,14,15,999999999 // Get current year, month and day carbon.Parse("2020-08-05 13:14:15").Date() // 2020,8,5 // Get current hour, minute and second carbon.Parse("2020-08-05 13:14:15").Time() // 13,14,15 // Get current century carbon.Parse("2020-08-05 13:14:15").Century() // 21 // Get current decade carbon.Parse("2019-08-05 13:14:15").Decade() // 10 carbon.Parse("2021-08-05 13:14:15").Decade() // 20 // Get current year carbon.Parse("2020-08-05 13:14:15").Year() // 2020 // Get current quarter carbon.Parse("2020-08-05 13:14:15").Quarter() // 3 // Get current month carbon.Parse("2020-08-05 13:14:15").Month() // 8 // Get current week(start from 0) carbon.Parse("2020-08-02 13:14:15").Week() // 0 carbon.Parse("2020-08-02").SetWeekStartsAt(carbon.Sunday).Week() // 0 carbon.Parse("2020-08-02").SetWeekStartsAt(carbon.Monday).Week() // 6 // Get current day carbon.Parse("2020-08-05 13:14:15").Day() // 5 // Get current hour carbon.Parse("2020-08-05 13:14:15").Hour() // 13 // Get current minute carbon.Parse("2020-08-05 13:14:15").Minute() // 14 // Get current second carbon.Parse("2020-08-05 13:14:15").Second() // 15 // Get current millisecond carbon.Parse("2020-08-05 13:14:15.999").Millisecond() // 999 // Get current microsecond carbon.Parse("2020-08-05 13:14:15.999").Microsecond() // 999000 // Get current nanosecond carbon.Parse("2020-08-05 13:14:15.999").Nanosecond() // 999000000 // Get timestamp with second carbon.Parse("2020-08-05 13:14:15").Timestamp() // 1596604455 // Get timestamp with millisecond carbon.Parse("2020-08-05 13:14:15").TimestampMilli() // 1596604455000 // Get timestamp with microsecond carbon.Parse("2020-08-05 13:14:15").TimestampMicro() // 1596604455000000 // Get timestamp with nanosecond carbon.Parse("2020-08-05 13:14:15").TimestampNano() // 1596604455000000000 // Get timezone name carbon.SetTimezone(carbon.PRC).Timezone() // CST carbon.SetTimezone(carbon.Tokyo).Timezone() // JST // Get location name carbon.SetTimezone(carbon.PRC).Location() // PRC carbon.SetTimezone(carbon.Tokyo).Location() // Asia/Tokyo // Get offset seconds from the UTC timezone carbon.SetTimezone(carbon.PRC).Offset() // 28800 carbon.SetTimezone(carbon.Tokyo).Offset() // 32400 // Get locale name carbon.Now().SetLocale("en").Locale() // en carbon.Now().SetLocale("zh-CN").Locale() // zh-CN // Get constellation name carbon.Now().Constellation() // Leo carbon.Now().SetLocale("en").Constellation() // Leo carbon.Now().SetLocale("zh-CN").Constellation() // 狮子座 //Get season name carbon.Now().Season() // Summer carbon.Now().SetLocale("en").Season() // Summer carbon.Now().SetLocale("zh-CN").Season() // 夏季 // Get current age carbon.Parse("2002-01-01 13:14:15").Age() // 17 carbon.Parse("2002-12-31 13:14:15").Age() // 18 ``` ##### Output ```go // Output a string in date and time format carbon.Parse("2020-08-05 13:14:15").ToDateTimeString() // 2020-08-05 13:14:15 // Output a string in date and time with millisecond format carbon.Parse("2020-08-05T13:14:15.999999999+08:00").ToDateTimeMilliString() // 2020-08-05 13:14:15.999 // Output a string in date and time with microsecond format carbon.Parse("2020-08-05T13:14:15.999999999+08:00").ToDateTimeMicroString() // 2020-08-05 13:14:15.999999 // Output a string in date and time with nanosecond format carbon.Parse("2020-08-05T13:14:15.999999999+08:00").ToDateTimeNanoString() // 2020-08-05 13:14:15.999999999 // Output a string in short date and time format carbon.Parse("2020-08-05T13:14:15.999999999+08:00").ToShortDateTimeString() // 20200805131415 // Output a string in short date and time with millisecond format carbon.Parse("2020-08-05T13:14:15.999999999+08:00").ToShortDateTimeMilliString() // 20200805131415.999 // Output a string in short date and time with microsecond format carbon.Parse("2020-08-05T13:14:15.999999999+08:00").ToShortDateTimeMicroString() // 20200805131415.999999 // Output a string in short date and time with nanosecond format carbon.Parse("2020-08-05T13:14:15.999999999+08:00").ToShortDateTimeNanoString() // 20200805131415.999999999 // Output a in date format string carbon.Parse("2020-08-05 13:14:15").ToDateString() // 2020-08-05 // Output a string in short date format carbon.Parse("2020-08-05 13:14:15").ToShortDateString() // 20200805 // Output a string in time format carbon.Parse("2020-08-05 13:14:15").ToTimeString() // 13:14:15 // Output a string in short time format carbon.Parse("2020-08-05 13:14:15").ToShortTimeString() // 131415 // Output a string in Ansic format carbon.Parse("2020-08-05 13:14:15").ToANSICString() // Wed Aug 5 13:14:15 2020 // Output a string in Atom format carbon.Parse("2020-08-05 13:14:15").ToAtomString() // 2020-08-05T13:14:15+08:00 // Output a string in unix date format carbon.Parse("2020-08-05 13:14:15").ToUnixDateString() // Wed Aug 5 13:14:15 CST 2020 // Output a string in ruby date format carbon.Parse("2020-08-05 13:14:15").ToRubyDateString() // Wed Aug 05 13:14:15 +0800 2020 // Output a string in Kitchen format carbon.Parse("2020-08-05 13:14:15").ToKitchenString() // 1:14PM // Output a string in Cookie format carbon.Parse("2020-08-05 13:14:15").ToCookieString() // Wednesday, 05-Aug-2020 13:14:15 CST // Output a string in day, date and time format carbon.Parse("2020-08-05 13:14:15").ToDayDateTimeString() // Wed, Aug 5, 2020 1:14 PM // Output a string in RSS format carbon.Parse("2020-08-05 13:14:15").ToRssString() // Wed, 05 Aug 2020 13:14:15 +0800 // Output a string in W3C format carbon.Parse("2020-08-05 13:14:15").ToW3cString() // 2020-08-05T13:14:15+08:00 // Output a string in ISO8601 format carbon.Parse("2020-08-05 13:14:15.999999999").ToIso8601String() // 2020-08-05T13:14:15+08:00 // Output a string in ISO8601 with millisecond format carbon.Parse("2020-08-05 13:14:15.999999999").ToIso8601MilliString() // 2020-08-05T13:14:15.999+08:00 // Output a string in ISO8601 with microsecond format carbon.Parse("2020-08-05 13:14:15.999999999").ToIso8601MicroString() // 2020-08-05T13:14:15.999999+08:00 // Output a string in ISO8601 with nanosecond format carbon.Parse("2020-08-05 13:14:15.999999999").ToIso8601NanoString() // 2020-08-05T13:14:15.999999999+08:00 // Output a string in RFC822 format carbon.Parse("2020-08-05 13:14:15").ToRfc822String() // 05 Aug 20 13:14 CST // Output a string in RFC822Z format carbon.Parse("2020-08-05 13:14:15").ToRfc822zString() // 05 Aug 20 13:14 +0800 // Output a string in RFC850 format carbon.Parse("2020-08-05 13:14:15").ToRfc850String() // Wednesday, 05-Aug-20 13:14:15 CST // Output a string in RFC1036 format carbon.Parse("2020-08-05 13:14:15").ToRfc1036String() // Wed, 05 Aug 20 13:14:15 +0800 // Output a string in RFC1123 format carbon.Parse("2020-08-05 13:14:15").ToRfc1123String() // Wed, 05 Aug 2020 13:14:15 CST // Output a string in RFC1123Z format carbon.Parse("2020-08-05 13:14:15").ToRfc1123zString() // Wed, 05 Aug 2020 13:14:15 +0800 // Output a string in RFC2822 format carbon.Parse("2020-08-05 13:14:15").ToRfc2822String() // Wed, 05 Aug 2020 13:14:15 +0800 // Output a string in RFC7231 format carbon.Parse("2020-08-05 13:14:15").ToRfc7231String() // Wed, 05 Aug 2020 13:14:15 GMT // Output a string in RFC3339 format carbon.Parse("2020-08-05T13:14:15.999999999+08:00").ToRfc3339String() // 2020-08-05T13:14:15+08:00 // Output a string in RFC3339 with millisecond format carbon.Parse("2020-08-05T13:14:15.999999999+08:00").ToRfc3339MilliString() // 2020-08-05T13:14:15.999+08:00 // Output a string in RFC3339 with microsecond format carbon.Parse("2020-08-05T13:14:15.999999999+08:00").ToRfc3339MicroString() // 2020-08-05T13:14:15.999999+08:00 // Output a string in RFC3339 with nanosecond format carbon.Parse("2020-08-05T13:14:15.999999999+08:00").ToRfc3339NanoString() // 2020-08-05T13:14:15.999999999+08:00 // Output a string in date and time format fmt.Sprintf("%s", carbon.Parse("2020-08-05 13:14:15")) // 2020-08-05 13:14:15 // Output a string in "2006-01-02 15:04:05.999999999 -0700 MST" format carbon.Parse("2020-08-05 13:14:15").ToString() // 2020-08-05 13:14:15.999999 +0800 CST // Output a string by layout, Layout() is shorthand for ToLayoutString() carbon.Parse("2020-08-05 13:14:15").Layout("20060102150405") // 20200805131415 carbon.Parse("2020-08-05 13:14:15").Layout("2006年01月02日 15时04分05秒") // 2020年08月05日 13时14分15秒 carbon.Parse("2020-08-05 13:14:15").Layout("It is 2006-01-02 15:04:05") // It is 2020-08-05 13:14:15 // Output a string by format, Format() is shorthand for ToFormatString() carbon.Parse("2020-08-05 13:14:15").Format("YmdHis") // 20200805131415 carbon.Parse("2020-08-05 13:14:15").Format("Y年m月d日 H时i分s秒") // 2020年08月05日 13时14分15秒 carbon.Parse("2020-08-05 13:14:15").Format("l jS \\o\\f F Y h:i:s A") // Wednesday 5th of August 2020 01:14:15 PM carbon.Parse("2020-08-05 13:14:15").Format("\\I\\t \\i\\s Y-m-d H:i:s") // It is 2020-08-05 13:14:15 ``` > For more supported format signs, please see the Format sign table ##### Constellation ```go // Get constellation name carbon.Parse("2020-08-05 13:14:15").Constellation() // Leo // Whether is Aries carbon.Parse("2020-08-05 13:14:15").IsAries() // false // Whether is Taurus carbon.Parse("2020-08-05 13:14:15").IsTaurus() // false // Whether is Gemini carbon.Parse("2020-08-05 13:14:15").IsGemini() // false // Whether is Cancer carbon.Parse("2020-08-05 13:14:15").IsCancer() // false // Whether is Leo carbon.Parse("2020-08-05 13:14:15").IsLeo() // true // Whether is Virgo carbon.Parse("2020-08-05 13:14:15").IsVirgo() // false // Whether is Libra carbon.Parse("2020-08-05 13:14:15").IsLibra() // false // Whether is Scorpio carbon.Parse("2020-08-05 13:14:15").IsScorpio() // false // Whether is Sagittarius carbon.Parse("2020-08-05 13:14:15").IsSagittarius() // false // Whether is Capricorn carbon.Parse("2020-08-05 13:14:15").IsCapricorn() // false // Whether is Aquarius carbon.Parse("2020-08-05 13:14:15").IsAquarius() // false // Whether is Pisces carbon.Parse("2020-08-05 13:14:15").IsPisces() // false ``` ##### Season > According to the meteorological division method, March to May is spring, June to August is summer, September to November is autumn, and December to February is winter ```go // Get season name carbon.Parse("2020-08-05 13:14:15").Season() // Summer // Start of the season carbon.Parse("2020-08-05 13:14:15").StartOfSeason().ToDateTimeString() // 2020-06-01 00:00:00 // End of the season carbon.Parse("2020-08-05 13:14:15").EndOfSeason().ToDateTimeString() // 2020-08-31 23:59:59 // Whether is spring carbon.Parse("2020-08-05 13:14:15").IsSpring() // false // Whether is summer carbon.Parse("2020-08-05 13:14:15").IsSummer() // true // Whether is autumn carbon.Parse("2020-08-05 13:14:15").IsAutumn() // false // Whether is winter carbon.Parse("2020-08-05 13:14:15").IsWinter() // false ``` ##### Chinese Lunar > Currently only `200` years from `1900` to `2100` are supported ```go // Get Chinese Lunar year of animal carbon.Parse("2020-08-05 13:14:15", carbon.PRC).Lunar().Animal() // 鼠 // Get Chinese lunar festival carbon.Parse("2021-02-12 13:14:15", carbon.PRC).Lunar().Festival() // 春节 // Get Chinese lunar year carbon.Parse("2020-08-05 13:14:15", carbon.PRC).Lunar().Year() // 2020 // Get Chinese lunar month carbon.Parse("2020-08-05 13:14:15", carbon.PRC).Lunar().Month() // 6 // Get Chinese lunar leap month carbon.Parse("2020-08-05 13:14:15", carbon.PRC).Lunar().LeapMonth() // 4 // Get Chinese lunar day carbon.Parse("2020-08-05 13:14:15", carbon.PRC).Lunar().Day() // 16 // Get Chinese lunar date as string in YYYY-MM-DD format fmt.Sprintf("%s", carbon.Parse("2020-08-05 13:14:15", carbon.PRC).Lunar()) // 2020-06-16 // Get Chinese lunar year as string carbon.Parse("2020-08-05 13:14:15", carbon.PRC).Lunar().ToYearString() // 二零二零 // Get Chinese lunar month as string carbon.Parse("2020-08-05 13:14:15", carbon.PRC).Lunar().ToMonthString() // 六 // Get Chinese lunar day as string carbon.Parse("2020-08-05 13:14:15", carbon.PRC).Lunar().ToDayString() // 十六 // Get Chinese lunar date as string carbon.Parse("2020-08-05 13:14:15", carbon.PRC).Lunar().ToDateString() // 二零二零年六月十六 // Whether is a leap year carbon.Parse("2020-08-05 13:14:15", carbon.PRC).Lunar().IsLeapYear() // true // Whether is a leap month carbon.Parse("2020-08-05 13:14:15", carbon.PRC).Lunar().IsLeapMonth() // false // Whether is a year of the rat carbon.Parse("2020-08-05 13:14:15", carbon.PRC).Lunar().IsRatYear() // true // Whether is a year of the ox carbon.Parse("2020-08-05 13:14:15", carbon.PRC).Lunar().IsOxYear() // false // Whether is a year of the tiger carbon.Parse("2020-08-05 13:14:15", carbon.PRC).Lunar().IsTigerYear() // false // Whether is a year of the rabbit carbon.Parse("2020-08-05 13:14:15", carbon.PRC).Lunar().IsRabbitYear() // false // Whether is a year of the dragon carbon.Parse("2020-08-05 13:14:15", carbon.PRC).Lunar().IsDragonYear() // false // Whether is a year of the snake carbon.Parse("2020-08-05 13:14:15", carbon.PRC).Lunar().IsSnakeYear() // false // Whether is a year of the horse carbon.Parse("2020-08-05 13:14:15", carbon.PRC).Lunar().IsHorseYear() // false // Whether is a year of the goat carbon.Parse("2020-08-05 13:14:15", carbon.PRC).Lunar().IsGoatYear() // false // Whether is a year of the monkey carbon.Parse("2020-08-05 13:14:15", carbon.PRC).Lunar().IsMonkeyYear() // false // Whether is a year of the rooster carbon.Parse("2020-08-05 13:14:15", carbon.PRC).Lunar().IsRoosterYear() // false // Whether is a year of the dog carbon.Parse("2020-08-05 13:14:15", carbon.PRC).Lunar().IsDogYear() // false // Whether is a year of the dig carbon.Parse("2020-08-05 13:14:15", carbon.PRC).Lunar().IsPigYear() // false ``` ##### JSON handling ###### Define model ```go type Person struct { Name string `json:"name"` Age int `json:"age"` Birthday carbon.DateTime `json:"birthday"` GraduatedAt carbon.Date `json:"graduated_at"` DateTime1 carbon.Timestamp `json:"date_time1"` DateTime2 carbon.TimestampMilli `json:"date_time2"` DateTime3 carbon.TimestampMicro `json:"date_time3"` DateTime4 carbon.TimestampNano `json:"date_time4"` } ``` ###### Instantiate model ```go person := Person { Name: "gouguoyin", Age: 18, Birthday: carbon.DateTime{carbon.Now().SubYears(18)}, GraduatedAt: carbon.Date{carbon.Parse("2020-08-05 13:14:15")}, DateTime1: carbon.Timestamp{carbon.Parse("2023-08-05 13:14:15")}, DateTime2: carbon.TimestampMilli{carbon.Parse("2024-08-05 13:14:15")}, DateTime3: carbon.TimestampMicro{carbon.Parse("2025-08-05 13:14:15")}, DateTime4: carbon.TimestampNano{carbon.Parse("2025-08-05 13:14:15")}, } ``` ###### JSON encode ```go data, err := json.Marshal(&person) if err != nil { // Error handle... log.Fatal(err) } fmt.Printf("%s", data) // Output { "name": "gouguoyin", "age": 18, "birthday": "2003-07-16 16:22:02", "graduated_at": "2020-08-05", "date_time1": 1691212455, "date_time2": 1722834855000, "date_time3": 1754370855000000, "date_time4": 1754370855000000000 } ``` ###### JSON decode ```go str := `{ "name": "gouguoyin", "age": 18, "birthday": "2003-07-16 16:22:02", "graduated_at": "2020-08-05", "date_time1": 1691212455, "date_time2": 1722834855000, "date_time3": 1754370855000000, "date_time4": 1754370855000000000 }` person := new(Person) err := json.Unmarshal([]byte(str), &person) if err != nil { // Error handle... log.Fatal(err) } fmt.Printf("%+v", *person) // Output {Name:gouguoyin Age:18 Birthday:2003-07-16 16:22:02 GraduatedAt:2020-08-05 00:00:00 DateTime1:2023-08-05 13:14:15 DateTime2:2024-08-05 13:14:15 DateTime3:2025-08-05 13:14:15 DateTime4:2025-08-05 13:14:15} ``` ##### I18n The following languages are supported * [English(en)](./lang/en.json "English") * [Japanese(jp)](./lang/jp.json "Japanese") * [Korean(kr)](./lang/kr.json "Korean") * [German(de)](./lang/de.json "German")：translated by [benzammour](https://github.com/benzammour "benzammour") * [Simplified Chinese(zh-CN)](./lang/zh-CN.json "Simplified Chinese")：translated by [gouguoyin](https://github.com/gouguoyin "gouguoyin") * [Traditional Chinese(zh-TW)](./lang/zh-TW.json "Traditional Chinese")：translated by [gouguoyin](https://github.com/gouguoyin "gouguoyin") * [Spanish(es)](./lang/es.json "Spanish")：translated by [hgisinger](https://github.com/hgisinger "hgisinger") * [Turkish(tr)](./lang/tr.json "Turkish"): translated by [emresenyuva](https://github.com/emresenyuva "emresenyuva") * [Portuguese(pt)](./lang/pt.json "Portuguese"): translated by [felipear89](https://github.com/felipear89 "felipear89") * [Russian(ru)](./lang/ru.json "Russian"): translated by [zemlyak](https://github.com/zemlyak "zemlyak") The following methods are supported * `Constellation()`：get constellation name * `Season()`：get season name * `DiffForHumans()`：get the difference in human friendly readable format * `ToMonthString()`：output a string in month format * `ToShortMonthString()`：output a string in short month format * `ToWeekString()`：output a string in week format * `ToShortWeekString()`：output a string in short week format ###### Set locale ```go lang := carbon.NewLanguage() lang.SetLocale("zh-CN") c := carbon.SetLanguage(lang) if c.Error != nil { // Error handle... log.Fatal(err) } c.Now().AddHours(1).DiffForHumans() // 1 小时后 c.Now().AddHours(1).ToMonthString() // 八月 c.Now().AddHours(1).ToShortMonthString() // 8月 c.Now().AddHours(1).ToWeekString() // 星期二 c.Now().AddHours(1).ToShortWeekString() // 周二 c.Now().AddHours(1).Constellation() // 狮子座 c.Now().AddHours(1).Season() // 夏季 ``` ###### Reset some resources(the rests still translate from the given locale) ```go lang := carbon.NewLanguage() lang.SetLocale("en") resources := map[string]string { "hour": "%dh", } lang.SetResources(resources) c := carbon.SetLanguage(lang) if c.Error != nil { // Error handle... log.Fatal(err) } c.Now().AddYears(1).DiffForHumans() // 1 year from now c.Now().AddHours(1).DiffForHumans() // 1h from now c.Now().ToMonthString() // August c.Now().ToShortMonthString() // Aug c.Now().ToWeekString() // Tuesday c.Now().ToShortWeekString() // Tue c.Now().Constellation() // Leo c.Now().Season() // Summer ``` ###### Reset all resources ```go lang := carbon.NewLanguage() resources := map[string]string { "months": "january|february|march|april|may|june|july|august|september|october|november|december", "short_months": "jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec", "weeks": "sunday|monday|tuesday|wednesday|thursday|friday|saturday", "short_weeks": "sun|mon|tue|wed|thu|fri|sat", "seasons": "spring|summer|autumn|winter", "constellations": "aries|taurus|gemini|cancer|leo|virgo|libra|scorpio|sagittarius|capricornus|aquarius|pisce", "year": "1 yr|%d yrs", "month": "1 mo|%d mos", "week": "%dw", "day": "%dd", "hour": "%dh", "minute": "%dm", "second": "%ds", "now": "just now", "ago": "%s ago", "from_now": "in %s", "before": "%s before", "after": "%s after", } lang.SetResources(resources) c := carbon.SetLanguage(lang) c.Now().AddYears(1).DiffForHumans() // in 1 yr c.Now().AddHours(1).DiffForHumans() // in 1h c.Now().ToMonthString() // august c.Now().ToShortMonthString() // aug c.Now().ToWeekString() // tuesday c.Now().ToShortWeekString() // tue c.Now().Constellation() // leo c.Now().Season() // summer ``` ##### Error handling > If more than one error occurs, only the first error is returned ###### Scene one ```go c := carbon.SetTimezone(PRC).Parse("xxx") if c.Error != nil { // Error handle... log.Fatal(c.Error) } fmt.Println(c.ToDateTimeString()) // Output cannot parse "xxx" as carbon, please make sure the value is valid ``` ###### Scene two ```go c := carbon.SetTimezone("xxx").Parse("2020-08-05") if c.Error != nil { // Error handle... log.Fatal(c.Error) } fmt.Println(c.ToDateTimeString()) // Output invalid timezone "xxx", please see the file "$GOROOT/lib/time/zoneinfo.zip" for all valid timezones ``` ###### Scene three ```go c := carbon.SetTimezone("xxx").Parse("12345678") if c.Error != nil { // Error handle... log.Fatal(c.Error) } fmt.Println(c.ToDateTimeString()) // Output invalid timezone "xxx", please see the file "$GOROOT/lib/time/zoneinfo.zip" for all valid timezones ``` #### Appendix ##### Format sign table | sign | desc | length | range | example | | :------------: | :------------: | :------------: | :------------: | :------------: | | d | Day of the month, padded to 2 | 2 | 01-31 | 02 | | D | Day of the week, as an abbreviate localized string | 3 | Mon-Sun | Mon | | j | Day of the month, no padding | - |1-31 | 2 | | S | English ordinal suffix for the day of the month, 2 characters. Eg: st, nd, rd or th. Works well with j | 2 | st/nd/rd/th | th | | l | Day of the week, as an unabbreviated localized string | - | Monday-Sunday | Monday | | F | Month as an unabbreviated localized string | - | January-December | January | | m | Month, padded to 2 | 2 | 01-12 | 01 | | M | Month as an abbreviated localized string | 3 | Jan-Dec | Jan | | n | Month, no padding | - | 1-12 | 1 | | Y | Four-digit year | 4 | 0000-9999 | 2006 | | y | Two-digit year | 2 | 00-99 | 06 | | a | Lowercase morning or afternoon sign | 2 | am/pm | pm | | A | Uppercase morning or afternoon sign | 2 | AM/PM | PM | | g | Hour in 12-hour time, no padding | - | 1-12 | 3 | | G | Hour in 24-hour time, no padding | - | 0-23 | 15 | | h | Hour in 12-hour time, padded to 2 | 2 | 00-11 | 03 | | H | Hour in 24-hour time, padded to 2 | 2 | 00-23 | 15 | | i | Minute, padded to 2 | 2 | 01-59 | 04 | | s | Second, padded to 2 | 2 | 01-59 | 05 | | c | ISO8601 date | - | - | 2006-01-02T15:04:05-07:00 | | r | RFC2822 date | - | - | Mon, 02 Jan 2006 15:04:05 -0700 | | O | Difference to Greenwich time (GMT) without colon between hours and minutes | - | - | +0700 | | P | Difference to Greenwich time (GMT) with colon between hours and minutes | - | - | +07:00 | | T | Abbreviated timezone | - | - | MST | | W | ISO8601 week of the year | - | 1-52 | 1 | | N | ISO8601 day of the week | 1 | 1-7 | 1 | | L | Whether it's a leap year | 1 | 0-1 | 0 | | U | Unix timestamp in seconds | 10 | - | 1611818268 | | u | Millisecond, padded to 3 | 3 | - | 999 | | w | Day of the week | 1 | 0-6 | 1 | | t | Total days of the month | 2 | 28-31 | 31 | | z | Day of the year | - | 0-365 | 2 | | e | Location | - | - | America/New_York | | Q | Quarter | 1 | 1-4 | 1 | | C | Century | - | 0-99 | 21 | #### References * [briannesbitt/carbon](https://github.com/briannesbitt/Carbon) * [jinzhu/now](https://github.com/jinzhu/now/) * [goframe/gtime](https://github.com/gogf/gf/tree/master/os/gtime) * [arrow-py/arrow](https://github.com/arrow-py/arrow) * [moment/moment](https://github.com/moment/moment) * [iamkun/dayjs](https://github.com/iamkun/dayjs)