carbon

package module
v2.6.9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 30, 2025 License: MIT Imports: 1 Imported by: 295

README

carbon

Carbon Release Go Test Go Report Card Go Coverage Carbon Doc License

English | 简体中文 | 日本語

Introduction

Carbon is a simple, semantic and developer-friendly time package for golang, 100% unit test coverage, doesn't depend on any third-party package and has been included by awesome-go and hello-github

Repository

github.com/dromara/carbon

gitee.com/dromara/carbon

gitcode.com/dromara/carbon

Quick Start

Installation

go version >= 1.21

// By github
go get -u github.com/dromara/carbon/v2
import "github.com/dromara/carbon/v2"

// By gitee
go get -u gitee.com/dromara/carbon/v2
import "gitee.com/dromara/carbon/v2"

// By gitcode
go get -u gitcode.com/dromara/carbon/v2
import "gitee.com/dromara/gitcode/v2"

Carbon was donated to the dromara organization, the repository URL has changed. If the previous repository used was golang-module/carbon, please replace the original repository with the new repository in go.mod, or execute the following command:

go mod edit -replace github.com/golang-module/carbon/v2 = github.com/dromara/carbon/v2

Example Usage

Default timezone is UTC, language locale is English, start day of the week is Monday and weekend days of the week are Saturday and Sunday.

carbon.SetTestNow(carbon.Parse("2020-08-05 13:14:15.999999999"))
carbon.IsTestNow() // true

carbon.Now().ToString() // 2020-08-05 13:14:15.999999999 +0000 UTC
carbon.Yesterday().ToString() // 2020-08-04 13:14:15.999999999 +0000 UTC
carbon.Tomorrow().ToString() // 2020-08-06 13:14:15.999999999 +0000 UTC

carbon.Parse("2020-08-05 13:14:15").ToString() // 2020-08-05 13:14:15 +0000 UTC
carbon.Parse("2022-03-08T03:01:14-07:00").ToString() // 2022-03-08 10:01:14 +0000 UTC

carbon.ParseByLayout("It is 2020-08-05 13:14:15", "It is 2006-01-02 15:04:05").ToString() // 2020-08-05 13:14:15 +0000 UTC
carbon.ParseByFormat("It is 2020-08-05 13:14:15", "\\I\\t \\i\\s Y-m-d H:i:s").ToString() // 2020-08-05 13:14:15 +0000 UTC

carbon.CreateFromDate(2020, 8, 5).ToString() // 2020-08-05 00:00:00 +0000 UTC
carbon.CreateFromTime(13, 14, 15).ToString() // 2020-08-05 13:14:15 +0000 UTC
carbon.CreateFromDateTime(2020, 8, 5, 13, 14, 15).ToString() // 2020-08-05 13:14:15 +0000 UTC
carbon.CreateFromTimestamp(1596633255).ToString() // 2020-08-05 13:14:15 +0000 UTC

carbon.Parse("2020-07-05 13:14:15").DiffForHumans() // 1 month before
carbon.Parse("2020-07-05 13:14:15").SetLocale("zh-CN").DiffForHumans() // 1 月前

carbon.ClearTestNow()
carbon.IsTestNow() // false

There are many more examples in the documentation

References

Contributors

Thanks to all the following who contributed to Carbon:

Sponsors

Carbon is a non-commercial open source project. If you want to support Carbon, you can buy a cup of coffee for developer.

Thanks

Carbon had been being developed with GoLand under the free JetBrains Open Source license, I would like to express my thanks here.

JetBrains

License

Carbon is licensed under the MIT License, see the LICENSE file for details.

Documentation

Overview

Package carbon is a simple, semantic and developer-friendly time package for golang.

Index

Constants

View Source
const (
	Local = carbon.Local // 本地时间
	UTC   = carbon.UTC   // 世界协调时间

	CET  = carbon.CET  // 欧洲中部标准时间
	EET  = carbon.EET  // 欧洲东部标准时间
	EST  = carbon.EST  // 美国东部标准时间
	GMT  = carbon.GMT  // 格林尼治标准时间
	MET  = carbon.MET  // 欧洲中部标准时间
	MST  = carbon.MST  // 美国山地标准时间
	UCT  = carbon.MST  // 世界协调时间
	WET  = carbon.WET  // 欧洲西部标准时间
	Zulu = carbon.Zulu // 世界协调时间

	Cuba      = carbon.Cuba      // 古巴
	Egypt     = carbon.Egypt     // 埃及
	Eire      = carbon.Eire      // 爱尔兰
	Greenwich = carbon.Greenwich // 格林尼治
	Iceland   = carbon.Iceland   // 冰岛
	Iran      = carbon.Iran      // 伊朗
	Israel    = carbon.Israel    // 以色列
	Jamaica   = carbon.Jamaica   // 牙买加
	Japan     = carbon.Japan     // 日本
	Libya     = carbon.Libya     // 利比亚
	Poland    = carbon.Poland    // 波兰
	Portugal  = carbon.Portugal  // 葡萄牙
	PRC       = carbon.PRC       // 中国
	Singapore = carbon.Singapore // 新加坡
	Turkey    = carbon.Turkey    // 土耳其

	Shanghai   = carbon.Shanghai   // 上海
	Chongqing  = carbon.Chongqing  // 重庆
	Harbin     = carbon.Harbin     // 哈尔滨
	Urumqi     = carbon.Urumqi     // 乌鲁木齐
	HongKong   = carbon.HongKong   // 香港
	Macao      = carbon.Macao      // 澳门
	Taipei     = carbon.Taipei     // 台北
	Tokyo      = carbon.Tokyo      // 东京
	HoChiMinh  = carbon.HoChiMinh  // 胡志明
	Hanoi      = carbon.Hanoi      // 河内
	Saigon     = carbon.Saigon     // 西贡
	Seoul      = carbon.Seoul      // 首尔
	Pyongyang  = carbon.Pyongyang  // 平壤
	Bangkok    = carbon.Bangkok    // 曼谷
	Dubai      = carbon.Dubai      // 迪拜
	Qatar      = carbon.Qatar      // 卡塔尔
	Bangalore  = carbon.Bangalore  // 班加罗尔
	Kolkata    = carbon.Kolkata    // 加尔各答
	Mumbai     = carbon.Mumbai     // 孟买
	MexicoCity = carbon.MexicoCity // 墨西哥
	NewYork    = carbon.NewYork    // 纽约
	LosAngeles = carbon.LosAngeles // 洛杉矶
	Chicago    = carbon.Chicago    // 芝加哥
	SaoPaulo   = carbon.SaoPaulo   // 圣保罗
	Moscow     = carbon.Moscow     // 莫斯科
	London     = carbon.London     // 伦敦
	Berlin     = carbon.Berlin     // 柏林
	Paris      = carbon.Paris      // 巴黎
	Rome       = carbon.Rome       // 罗马
	Sydney     = carbon.Sydney     // 悉尼
	Melbourne  = carbon.Melbourne  // 墨尔本
	Darwin     = carbon.Darwin     // 达尔文
)

timezone constants 时区常量

View Source
const (
	January   = carbon.January   // 一月
	February  = carbon.February  // 二月
	March     = carbon.March     // 三月
	April     = carbon.April     // 四月
	May       = carbon.May       // 五月
	June      = carbon.June      // 六月
	July      = carbon.July      // 七月
	August    = carbon.August    // 八月
	September = carbon.September // 九月
	October   = carbon.October   // 十月
	November  = carbon.November  // 十一月
	December  = carbon.December  // 十二月
)

month constants 月份常量

View Source
const (
	Aries       = carbon.Aries       // 白羊座
	Taurus      = carbon.Taurus      // 金牛座
	Gemini      = carbon.Gemini      // 双子座
	Cancer      = carbon.Cancer      // 巨蟹座
	Leo         = carbon.Leo         // 狮子座
	Virgo       = carbon.Virgo       // 处女座
	Libra       = carbon.Libra       // 天秤座
	Scorpio     = carbon.Scorpio     // 天蝎座
	Sagittarius = carbon.Sagittarius // 射手座
	Capricorn   = carbon.Capricorn   // 摩羯座
	Aquarius    = carbon.Aquarius    // 水瓶座
	Pisces      = carbon.Pisces      // 双鱼座
)

constellation constants 星座常量

View Source
const (
	Monday    = carbon.Monday    // 周一
	Tuesday   = carbon.Tuesday   // 周二
	Wednesday = carbon.Wednesday // 周三
	Thursday  = carbon.Thursday  // 周四
	Friday    = carbon.Friday    // 周五
	Saturday  = carbon.Saturday  // 周六
	Sunday    = carbon.Sunday    // 周日
)

week constants 星期常量

View Source
const (
	Spring = carbon.Spring // 春季
	Summer = carbon.Summer // 夏季
	Autumn = carbon.Autumn // 秋季
	Winter = carbon.Winter // 冬季
)

season constants 季节常量

View Source
const (
	EpochYear          = carbon.EpochYear          // UNIX 纪元年
	YearsPerMillennium = carbon.YearsPerMillennium // 每千年1000年
	YearsPerCentury    = carbon.YearsPerCentury    // 每世纪100年
	YearsPerDecade     = carbon.YearsPerDecade     // 每十年10年
	QuartersPerYear    = carbon.QuartersPerYear    // 每年4个季度
	MonthsPerYear      = carbon.MonthsPerYear      // 每年12月
	MonthsPerQuarter   = carbon.MonthsPerQuarter   // 每季度3月
	WeeksPerNormalYear = carbon.WeeksPerNormalYear // 每常规年52周
	WeeksPerLongYear   = carbon.WeeksPerLongYear   // 每长年53周
	WeeksPerMonth      = carbon.WeeksPerMonth      // 每月4周
	DaysPerLeapYear    = carbon.DaysPerLeapYear    // 每闰年366天
	DaysPerNormalYear  = carbon.DaysPerNormalYear  // 每常规年365天
	DaysPerWeek        = carbon.DaysPerWeek        // 每周7天
	HoursPerWeek       = carbon.HoursPerWeek       // 每周168小时
	HoursPerDay        = carbon.HoursPerDay        // 每天24小时
	MinutesPerDay      = carbon.MinutesPerDay      // 每天1440分钟
	MinutesPerHour     = carbon.MinutesPerHour     // 每小时60分钟
	SecondsPerWeek     = carbon.SecondsPerWeek     // 每周604800秒
	SecondsPerDay      = carbon.SecondsPerDay      // 每天86400秒
	SecondsPerHour     = carbon.SecondsPerHour     // 每小时3600秒
	SecondsPerMinute   = carbon.SecondsPerMinute   // 每分钟60秒
)

number constants 数字常量

View Source
const (
	AtomLayout     = carbon.AtomLayout
	ANSICLayout    = carbon.ANSICLayout
	CookieLayout   = carbon.CookieLayout
	KitchenLayout  = carbon.KitchenLayout
	RssLayout      = carbon.RssLayout
	RubyDateLayout = carbon.RubyDateLayout
	UnixDateLayout = carbon.UnixDateLayout
	W3cLayout      = carbon.W3cLayout

	RFC1036Layout      = carbon.RFC1036Layout
	RFC1123Layout      = carbon.RFC1123Layout
	RFC1123ZLayout     = carbon.RFC1123ZLayout
	RFC2822Layout      = carbon.RFC2822Layout
	RFC3339Layout      = carbon.RFC3339Layout
	RFC3339MilliLayout = carbon.RFC3339MilliLayout
	RFC3339MicroLayout = carbon.RFC3339MicroLayout
	RFC3339NanoLayout  = carbon.RFC3339NanoLayout
	RFC7231Layout      = carbon.RFC7231Layout
	RFC822Layout       = carbon.RFC822Layout
	RFC822ZLayout      = carbon.RFC822ZLayout
	RFC850Layout       = carbon.RFC850Layout

	ISO8601Layout      = carbon.ISO8601Layout
	ISO8601MilliLayout = carbon.ISO8601MilliLayout
	ISO8601MicroLayout = carbon.ISO8601MicroLayout
	ISO8601NanoLayout  = carbon.ISO8601NanoLayout

	ISO8601ZuluLayout      = carbon.ISO8601ZuluLayout
	ISO8601ZuluMilliLayout = carbon.ISO8601ZuluMilliLayout
	ISO8601ZuluMicroLayout = carbon.ISO8601ZuluMicroLayout
	ISO8601ZuluNanoLayout  = carbon.ISO8601ZuluNanoLayout

	FormattedDateLayout    = carbon.FormattedDateLayout
	FormattedDayDateLayout = carbon.FormattedDayDateLayout

	DayDateTimeLayout        = carbon.DayDateTimeLayout
	DateTimeLayout           = carbon.DateTimeLayout
	DateTimeMilliLayout      = carbon.DateTimeMilliLayout
	DateTimeMicroLayout      = carbon.DateTimeMicroLayout
	DateTimeNanoLayout       = carbon.DateTimeNanoLayout
	ShortDateTimeLayout      = carbon.ShortDateTimeLayout
	ShortDateTimeMilliLayout = carbon.ShortDateTimeMilliLayout
	ShortDateTimeMicroLayout = carbon.ShortDateTimeMicroLayout
	ShortDateTimeNanoLayout  = carbon.ShortDateTimeNanoLayout

	DateLayout           = carbon.DateLayout
	DateMilliLayout      = carbon.DateMilliLayout
	DateMicroLayout      = carbon.DateMicroLayout
	DateNanoLayout       = carbon.DateNanoLayout
	ShortDateLayout      = carbon.ShortDateLayout
	ShortDateMilliLayout = carbon.ShortDateMilliLayout
	ShortDateMicroLayout = carbon.ShortDateMicroLayout
	ShortDateNanoLayout  = carbon.ShortDateNanoLayout

	TimeLayout           = carbon.TimeLayout
	TimeMilliLayout      = carbon.TimeMilliLayout
	TimeMicroLayout      = carbon.TimeMicroLayout
	TimeNanoLayout       = carbon.TimeNanoLayout
	ShortTimeLayout      = carbon.ShortTimeLayout
	ShortTimeMilliLayout = carbon.ShortTimeMilliLayout
	ShortTimeMicroLayout = carbon.ShortTimeMicroLayout
	ShortTimeNanoLayout  = carbon.ShortTimeNanoLayout

	TimestampLayout      = carbon.TimestampLayout
	TimestampMilliLayout = carbon.TimestampMilliLayout
	TimestampMicroLayout = carbon.TimestampMicroLayout
	TimestampNanoLayout  = carbon.TimestampNanoLayout
)

layout constants 布局模板常量

View Source
const (
	AtomFormat     = carbon.AtomFormat
	ANSICFormat    = carbon.ANSICFormat
	CookieFormat   = carbon.CookieFormat
	KitchenFormat  = carbon.KitchenFormat
	RssFormat      = carbon.RssFormat
	RubyDateFormat = carbon.RubyDateFormat
	UnixDateFormat = carbon.UnixDateFormat

	RFC1036Format      = carbon.RFC1036Format
	RFC1123Format      = carbon.RFC1123Format
	RFC1123ZFormat     = carbon.RFC1123ZFormat
	RFC2822Format      = carbon.RFC2822Format
	RFC3339Format      = carbon.RFC3339Format
	RFC3339MilliFormat = carbon.RFC3339MilliFormat
	RFC3339MicroFormat = carbon.RFC3339MicroFormat
	RFC3339NanoFormat  = carbon.RFC3339NanoFormat
	RFC7231Format      = carbon.RFC7231Format
	RFC822Format       = carbon.RFC822Format
	RFC822ZFormat      = carbon.RFC822ZFormat
	RFC850Format       = carbon.RFC850Format

	ISO8601Format      = carbon.ISO8601Format
	ISO8601MilliFormat = carbon.ISO8601MilliFormat
	ISO8601MicroFormat = carbon.ISO8601MicroFormat
	ISO8601NanoFormat  = carbon.ISO8601NanoFormat

	ISO8601ZuluFormat      = carbon.ISO8601ZuluFormat
	ISO8601ZuluMilliFormat = carbon.ISO8601ZuluMilliFormat
	ISO8601ZuluMicroFormat = carbon.ISO8601ZuluMicroFormat
	ISO8601ZuluNanoFormat  = carbon.ISO8601ZuluNanoFormat

	FormattedDateFormat    = carbon.FormattedDateFormat
	FormattedDayDateFormat = carbon.FormattedDayDateFormat

	DayDateTimeFormat        = carbon.DayDateTimeFormat
	DateTimeFormat           = carbon.DateTimeFormat
	DateTimeMilliFormat      = carbon.DateTimeMilliFormat
	DateTimeMicroFormat      = carbon.DateTimeMicroFormat
	DateTimeNanoFormat       = carbon.DateTimeNanoFormat
	ShortDateTimeFormat      = carbon.ShortDateTimeFormat
	ShortDateTimeMilliFormat = carbon.ShortDateTimeMilliFormat
	ShortDateTimeMicroFormat = carbon.ShortDateTimeMicroFormat
	ShortDateTimeNanoFormat  = carbon.ShortDateTimeNanoFormat

	DateFormat           = carbon.DateFormat
	DateMilliFormat      = carbon.DateMilliFormat
	DateMicroFormat      = carbon.DateMicroFormat
	DateNanoFormat       = carbon.DateNanoFormat
	ShortDateFormat      = carbon.ShortDateFormat
	ShortDateMilliFormat = carbon.ShortDateMilliFormat
	ShortDateMicroFormat = carbon.ShortDateMicroFormat
	ShortDateNanoFormat  = carbon.ShortDateNanoFormat

	TimeFormat           = carbon.TimeFormat
	TimeMilliFormat      = carbon.TimeMilliFormat
	TimeMicroFormat      = carbon.TimeMicroFormat
	TimeNanoFormat       = carbon.TimeNanoFormat
	ShortTimeFormat      = carbon.ShortTimeFormat
	ShortTimeMilliFormat = carbon.ShortTimeMilliFormat
	ShortTimeMicroFormat = carbon.ShortTimeMicroFormat
	ShortTimeNanoFormat  = carbon.ShortTimeNanoFormat

	TimestampFormat      = carbon.TimestampFormat
	TimestampMilliFormat = carbon.TimestampMilliFormat
	TimestampMicroFormat = carbon.TimestampMicroFormat
	TimestampNanoFormat  = carbon.TimestampNanoFormat
)

format constants 格式模板常量

View Source
const Version = "2.6.8"

Version current version 当前版本号

Variables

View Source
var (
	// DefaultLayout default layout
	DefaultLayout = carbon.DateTimeLayout

	// DefaultTimezone default timezone
	DefaultTimezone = carbon.UTC

	// DefaultLocale default language locale
	DefaultLocale = carbon.DefaultLocale

	// DefaultWeekStartsAt default start date of the week
	DefaultWeekStartsAt = carbon.DefaultWeekStartsAt

	// DefaultWeekendDays default weekend days of the week
	DefaultWeekendDays = carbon.DefaultWeekendDays
)

Functions

func CleanTestNow added in v2.5.10

func CleanTestNow()

CleanTestNow cleans the test Carbon instance for now. Deprecated: it will be removed in the future, use ClearTestNow instead.

func ClearTestNow added in v2.2.5

func ClearTestNow()

ClearTestNow clears the test Carbon instance for now.

func IsTestNow added in v2.2.5

func IsTestNow() bool

IsTestNow reports whether is testing time.

func ResetDefault added in v2.5.10

func ResetDefault()

ResetDefault resets default.

func SetDefault added in v2.3.4

func SetDefault(d Default)

SetDefault sets default.

func SetTestNow added in v2.2.5

func SetTestNow(c *Carbon)

SetTestNow sets a test Carbon instance for now, remember to clear after use.

Types

type Carbon

type Carbon = carbon.Carbon

func CreateFromDate

func CreateFromDate(year, month, day int, timezone ...string) *Carbon

CreateFromDate creates a Carbon instance from a given date.

func CreateFromDateMicro added in v2.1.6

func CreateFromDateMicro(year, month, day, microsecond int, timezone ...string) *Carbon

CreateFromDateMicro creates a Carbon instance from a given date and microsecond.

func CreateFromDateMilli added in v2.1.6

func CreateFromDateMilli(year, month, day, millisecond int, timezone ...string) *Carbon

CreateFromDateMilli creates a Carbon instance from a given date and millisecond.

func CreateFromDateNano added in v2.1.6

func CreateFromDateNano(year, month, day, nanosecond int, timezone ...string) *Carbon

CreateFromDateNano creates a Carbon instance from a given date and nanosecond.

func CreateFromDateTime

func CreateFromDateTime(year, month, day, hour, minute, second int, timezone ...string) *Carbon

CreateFromDateTime creates a Carbon instance from a given date and time.

func CreateFromDateTimeMicro added in v2.1.0

func CreateFromDateTimeMicro(year, month, day, hour, minute, second, microsecond int, timezone ...string) *Carbon

CreateFromDateTimeMicro creates a Carbon instance from a given date, time and microsecond.

func CreateFromDateTimeMilli added in v2.1.0

func CreateFromDateTimeMilli(year, month, day, hour, minute, second, millisecond int, timezone ...string) *Carbon

CreateFromDateTimeMilli creates a Carbon instance from a given date, time and millisecond.

func CreateFromDateTimeNano added in v2.1.0

func CreateFromDateTimeNano(year, month, day, hour, minute, second, nanosecond int, timezone ...string) *Carbon

CreateFromDateTimeNano creates a Carbon instance from a given date, time and nanosecond.

func CreateFromStdTime added in v2.2.4

func CreateFromStdTime(stdTime StdTime, timezone ...string) *Carbon

CreateFromStdTime creates a Carbon instance from standard time.Time.

func CreateFromTime

func CreateFromTime(hour, minute, second int, timezone ...string) *Carbon

CreateFromTime creates a Carbon instance from a given time(year, month and day are taken from the current time).

func CreateFromTimeMicro added in v2.1.6

func CreateFromTimeMicro(hour, minute, second, microsecond int, timezone ...string) *Carbon

CreateFromTimeMicro creates a Carbon instance from a given time and microsecond(year, month and day are taken from the current time).

func CreateFromTimeMilli added in v2.1.6

func CreateFromTimeMilli(hour, minute, second, millisecond int, timezone ...string) *Carbon

CreateFromTimeMilli creates a Carbon instance from a given time and millisecond(year, month and day are taken from the current time).

func CreateFromTimeNano added in v2.1.6

func CreateFromTimeNano(hour, minute, second, nanosecond int, timezone ...string) *Carbon

CreateFromTimeNano creates a Carbon instance from a given time and nanosecond(year, month and day are taken from the current time).

func CreateFromTimestamp

func CreateFromTimestamp(timestamp int64, timezone ...string) *Carbon

CreateFromTimestamp creates a Carbon instance from a given timestamp with second precision.

func CreateFromTimestampMicro added in v2.1.0

func CreateFromTimestampMicro(timestampMicro int64, timezone ...string) *Carbon

CreateFromTimestampMicro creates a Carbon instance from a given timestamp with microsecond precision.

func CreateFromTimestampMilli added in v2.1.0

func CreateFromTimestampMilli(timestampMilli int64, timezone ...string) *Carbon

CreateFromTimestampMilli creates a Carbon instance from a given timestamp with millisecond precision.

func CreateFromTimestampNano added in v2.1.0

func CreateFromTimestampNano(timestampNano int64, timezone ...string) *Carbon

CreateFromTimestampNano creates a Carbon instance from a given timestamp with nanosecond precision.

func EpochValue added in v2.6.7

func EpochValue() *Carbon

EpochValue returns the unix epoch value of Carbon instance.

func Max added in v2.3.5

func Max(c1 *Carbon, c2 ...*Carbon) (c *Carbon)

Max returns the maximum Carbon instance from some given Carbon instances.

func MaxValue added in v2.5.10

func MaxValue() *Carbon

MaxValue returns the maximum value of Carbon instance.

func Min added in v2.3.5

func Min(c1 *Carbon, c2 ...*Carbon) (c *Carbon)

Min returns the minimum Carbon instance from some given Carbon instances.

func MinValue added in v2.5.10

func MinValue() *Carbon

MinValue returns the minimum value of Carbon instance.

func NewCarbon

func NewCarbon(time ...StdTime) *Carbon

NewCarbon returns a new Carbon instance.

func Now

func Now(timezone ...string) *Carbon

func Parse

func Parse(value string, timezone ...string) *Carbon

Parse parses a standard time string as a Carbon instance.

func ParseByFormat

func ParseByFormat(value, format string, timezone ...string) *Carbon

ParseByFormat parses a time string as a Carbon instance by a confirmed format.

func ParseByFormats added in v2.5.10

func ParseByFormats(value string, formats []string, timezone ...string) *Carbon

ParseByFormats parses a time string as a Carbon instance by multiple fuzzy formats.

Note: it doesn't support parsing by timestamp formats.

func ParseByLayout

func ParseByLayout(value, layout string, timezone ...string) *Carbon

ParseByLayout parses a time string as a Carbon instance by a confirmed layout

func ParseByLayouts added in v2.5.10

func ParseByLayouts(value string, layouts []string, timezone ...string) *Carbon

ParseByLayouts parses a time string as a Carbon instance by multiple fuzzy layouts.

Note: it doesn't support parsing by timestamp layouts.

func ParseWithFormats deprecated added in v2.5.10

func ParseWithFormats(value string, formats []string, timezone ...string) *Carbon

ParseWithFormats parses a time string as a Carbon instance by multiple fuzzy formats.

Deprecated: it will be removed in the future, use ParseByFormats instead.

func ParseWithLayouts deprecated added in v2.5.10

func ParseWithLayouts(value string, layouts []string, timezone ...string) *Carbon

ParseWithLayouts parses a time string as a Carbon instance by multiple fuzzy layouts.

Deprecated: it will be removed in the future, use ParseByLayouts instead.

func SetFormat added in v2.5.10

func SetFormat(format string) *Carbon

SetFormat sets globally default format.

func SetLayout added in v2.5.10

func SetLayout(layout string) *Carbon

SetLayout sets globally default layout.

func SetLocale

func SetLocale(locale string) *Carbon

SetLocale sets globally default locale.

func SetLocation added in v2.1.9

func SetLocation(loc *Location) *Carbon

SetLocation sets globally default location.

func SetTimezone

func SetTimezone(name string) *Carbon

SetTimezone sets globally default timezone.

func SetWeekStartsAt added in v2.3.5

func SetWeekStartsAt(weekday Weekday) *Carbon

SetWeekStartsAt sets globally default start day of the week.

func SetWeekendDays added in v2.5.10

func SetWeekendDays(weekDays []Weekday) *Carbon

SetWeekendDays sets globally default weekend days of the week.

func Tomorrow

func Tomorrow(timezone ...string) *Carbon

func Yesterday

func Yesterday(timezone ...string) *Carbon

func ZeroValue added in v2.6.7

func ZeroValue() *Carbon

ZeroValue returns the zero value of Carbon instance.

type Date

type Date = carbon.Date

func NewDate added in v2.5.10

func NewDate(c *Carbon) *Date

type DateMicro added in v2.1.6

type DateMicro = carbon.DateMicro

func NewDateMicro added in v2.5.10

func NewDateMicro(c *Carbon) *DateMicro

type DateMilli added in v2.1.6

type DateMilli = carbon.DateMilli

func NewDateMilli added in v2.5.10

func NewDateMilli(c *Carbon) *DateMilli

type DateNano added in v2.1.6

type DateNano = carbon.DateNano

func NewDateNano added in v2.5.10

func NewDateNano(c *Carbon) *DateNano

type DateTime

type DateTime = carbon.DateTime

func NewDateTime added in v2.5.10

func NewDateTime(c *Carbon) *DateTime

type DateTimeMicro added in v2.1.6

type DateTimeMicro = carbon.DateTimeMicro

func NewDateTimeMicro added in v2.5.10

func NewDateTimeMicro(c *Carbon) *DateTimeMicro

type DateTimeMilli added in v2.1.6

type DateTimeMilli = carbon.DateTimeMilli

func NewDateTimeMilli added in v2.5.10

func NewDateTimeMilli(c *Carbon) *DateTimeMilli

type DateTimeNano added in v2.1.6

type DateTimeNano = carbon.DateTimeNano

func NewDateTimeNano added in v2.5.10

func NewDateTimeNano(c *Carbon) *DateTimeNano

type Default added in v2.3.4

type Default = carbon.Default

type Duration added in v2.5.10

type Duration = carbon.Duration

func MaxDuration added in v2.5.10

func MaxDuration() Duration

MaxDuration returns the maximum value of duration instance.

func MinDuration added in v2.5.10

func MinDuration() Duration

MinDuration returns the minimum value of duration instance.

type FormatType added in v2.6.5

type FormatType[T FormatTyper] = carbon.FormatType[T]

func NewFormatType added in v2.6.5

func NewFormatType[T FormatTyper](c *Carbon) *FormatType[T]

type FormatTyper added in v2.6.5

type FormatTyper = carbon.FormatTyper

type Language

type Language = carbon.Language

func NewLanguage

func NewLanguage() *Language

type LayoutType added in v2.6.5

type LayoutType[T LayoutTyper] = carbon.LayoutType[T]

func NewLayoutType added in v2.6.5

func NewLayoutType[T LayoutTyper](c *Carbon) *LayoutType[T]

type LayoutTyper added in v2.6.5

type LayoutTyper = carbon.LayoutTyper

type Location added in v2.5.10

type Location = carbon.Location

type StdTime added in v2.5.10

type StdTime = carbon.StdTime

type Time

type Time = carbon.Time

func NewTime added in v2.5.10

func NewTime(c *Carbon) *Time

type TimeMicro added in v2.2.8

type TimeMicro = carbon.TimeMicro

func NewTimeMicro added in v2.5.10

func NewTimeMicro(c *Carbon) *TimeMicro

type TimeMilli added in v2.2.8

type TimeMilli = carbon.TimeMilli

func NewTimeMilli added in v2.5.10

func NewTimeMilli(c *Carbon) *TimeMilli

type TimeNano added in v2.2.8

type TimeNano = carbon.TimeNano

func NewTimeNano added in v2.5.10

func NewTimeNano(c *Carbon) *TimeNano

type Timestamp

type Timestamp = carbon.Timestamp

func NewTimestamp added in v2.5.10

func NewTimestamp(c *Carbon) *Timestamp

type TimestampMicro added in v2.1.0

type TimestampMicro = carbon.TimestampMicro

func NewTimestampMicro added in v2.5.10

func NewTimestampMicro(c *Carbon) *TimestampMicro

type TimestampMilli added in v2.1.0

type TimestampMilli = carbon.TimestampMilli

func NewTimestampMilli added in v2.5.10

func NewTimestampMilli(c *Carbon) *TimestampMilli

type TimestampNano added in v2.1.0

type TimestampNano = carbon.TimestampNano

func NewTimestampNano added in v2.5.10

func NewTimestampNano(c *Carbon) *TimestampNano

type Weekday added in v2.5.10

type Weekday = carbon.Weekday

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL