carbon

package
v1.16.2 Latest Latest
Warning

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

 Go to latest Published: Sep 9, 2025 License: MIT Imports: 2 Imported by: 44

Documentation

Index

Constants

View Source 
const (
	Local = carbon.Local // 本地时间
	UTC   = carbon.UTC   // 世界协调时间
	GMT   = carbon.GMT   // 格林尼治标准时间
	EET   = carbon.EET   // 欧洲东部标准时间
	WET   = carbon.WET   // 欧洲西部标准时间
	CET   = carbon.CET   // 欧洲中部标准时间
	EST   = carbon.EST   // 美国东部标准时间
	MST   = carbon.MST   // 美国山地标准时间

	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      // 东京
	Saigon     = carbon.Saigon     // 西贡
	Seoul      = carbon.Seoul      // 首尔
	Bangkok    = carbon.Bangkok    // 曼谷
	Dubai      = carbon.Dubai      // 迪拜
	NewYork    = carbon.NewYork    // 纽约
	LosAngeles = carbon.LosAngeles // 洛杉矶
	Chicago    = carbon.Chicago    // 芝加哥
	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 (
	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 (
	ANSICLayout              = carbon.ANSICLayout
	UnixDateLayout           = carbon.UnixDateLayout
	RubyDateLayout           = carbon.RubyDateLayout
	RFC822Layout             = carbon.RFC822Layout
	RFC822ZLayout            = carbon.RFC822ZLayout
	RFC850Layout             = carbon.RFC850Layout
	RFC1123Layout            = carbon.RFC1123Layout
	RFC1123ZLayout           = carbon.RFC1123ZLayout
	RssLayout                = carbon.RssLayout
	KitchenLayout            = carbon.KitchenLayout
	RFC2822Layout            = carbon.RFC2822Layout
	CookieLayout             = carbon.CookieLayout
	RFC3339Layout            = carbon.RFC3339Layout
	RFC3339MilliLayout       = carbon.RFC3339MilliLayout
	RFC3339MicroLayout       = carbon.RFC3339MicroLayout
	RFC3339NanoLayout        = carbon.RFC3339NanoLayout
	ISO8601Layout            = carbon.ISO8601Layout
	ISO8601MilliLayout       = carbon.ISO8601MilliLayout
	ISO8601MicroLayout       = carbon.ISO8601MicroLayout
	ISO8601NanoLayout        = carbon.ISO8601NanoLayout
	RFC1036Layout            = carbon.RFC1036Layout
	RFC7231Layout            = carbon.RFC7231Layout
	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
)

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 格式模板常量

Variables

This section is empty.

Functions

func ClearTestNow added in v1.15.12 

func ClearTestNow()

ClearTestNow clears the test time.

func IsTestNow 

func IsTestNow() bool

IsTestNow determines if the test now time is set.

func SetLocale added in v1.15.7 

func SetLocale(locale string)

SetLocale sets language locale.

func SetTestNow 

func SetTestNow(c *Carbon)

SetTestNow sets the test time, remember to clean after use.

func SetTimezone 

func SetTimezone(timezone string)

SetTimezone sets timezone.

func UnsetTestNow deprecated 

func UnsetTestNow()

UnsetTestNow unsets the test time.

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

Types

type Carbon 

type Carbon = carbon.Carbon

func EpochValue added in v1.15.12 

func EpochValue() *Carbon

EpochValue returns the unix epoch value of Carbon object.

func FromDate 

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

FromDate returns a Carbon object of given date.

func FromDateMicro 

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

FromDateMicro returns a Carbon object of given microsecond date.

func FromDateMilli 

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

FromDateMilli returns a Carbon object of given millisecond date.

func FromDateNano 

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

FromDateNano returns a Carbon object of given nanosecond date.

func FromDateTime 

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

FromDateTime returns a Carbon object of given date and time.

func FromDateTimeMicro 

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

FromDateTimeMicro returns a Carbon object of given date and microsecond time.

func FromDateTimeMilli 

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

FromDateTimeMilli returns a Carbon object of given date and millisecond time.

func FromDateTimeNano 

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

FromDateTimeNano returns a Carbon object of given date and nanosecond time.

func FromHebrew added in v1.15.12 

func FromHebrew(year, month, day int) *Carbon

FromHebrew returns a Carbon object from Hebrew date.

func FromJulian added in v1.15.12 

func FromJulian(f float64) *Carbon

FromJulian returns a Carbon object from Julian Day or Modified Julian Day.

func FromLunar added in v1.15.12 

func FromLunar(year, month, day int, isLeapMonth bool) *Carbon

FromLunar returns a Carbon object from Lunar date.

func FromPersian added in v1.15.12 

func FromPersian(year, month, day int) *Carbon

FromPersian returns a Carbon object from Persian date.

func FromStdTime 

func FromStdTime(time stdtime.Time, timezone ...string) *Carbon

FromStdTime returns a Carbon object of given time.Time object.

func FromTime 

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

FromTime returns a Carbon object of given time.

func FromTimeMicro 

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

FromTimeMicro returns a Carbon object of given microsecond time.

func FromTimeMilli 

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

FromTimeMilli returns a Carbon object of given millisecond time.

func FromTimeNano 

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

FromTimeNano returns a Carbon object of given nanosecond time.

func FromTimestamp 

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

FromTimestamp returns a Carbon object of given timestamp.

func FromTimestampMicro 

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

FromTimestampMicro returns a Carbon object of given microsecond timestamp.

func FromTimestampMilli 

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

FromTimestampMilli returns a Carbon object of given millisecond timestamp.

func FromTimestampNano 

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

FromTimestampNano returns a Carbon object of given nanosecond timestamp.

func New added in v1.15.12 

func New(time ...stdtime.Time) *Carbon

New returns a new Carbon object.

func Now 

func Now(timezone ...string) *Carbon

Now returns a Carbon object of now.

func Parse 

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

Parse returns a Carbon object of given value.

func ParseByFormat 

func ParseByFormat[T string | []string](value string, format T, timezone ...string) (c *Carbon)

ParseByFormat returns a Carbon object by a confirmed format.

func ParseByLayout 

func ParseByLayout[T string | []string](value string, layout T, timezone ...string) (c *Carbon)

ParseByLayout returns a Carbon object by a confirmed layout.

func ParseWithFormats deprecated added in v1.15.7 

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

ParseWithFormats returns a Carbon object with multiple fuzzy formats.

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

func ParseWithLayouts deprecated added in v1.15.7 

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

ParseWithLayouts returns a Carbon object with multiple fuzzy layouts.

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

func ZeroValue added in v1.15.12 

func ZeroValue() *Carbon

ZeroValue returns the zero value of Carbon object.

type Date 

type Date = carbon.LayoutType[DateType]

func NewDate 

func NewDate(c *Carbon) *Date

type DateMicro 

type DateMicro = carbon.LayoutType[DateMicroType]

func NewDateMicro 

func NewDateMicro(c *Carbon) *DateMicro

type DateMicroType added in v1.15.12 

type DateMicroType string

func (DateMicroType) Layout added in v1.15.12 

func (t DateMicroType) Layout() string

type DateMilli 

type DateMilli = carbon.LayoutType[DateMilliType]

func NewDateMilli 

func NewDateMilli(c *Carbon) *DateMilli

type DateMilliType added in v1.15.12 

type DateMilliType string

func (DateMilliType) Layout added in v1.15.12 

func (t DateMilliType) Layout() string

type DateNano 

type DateNano = carbon.LayoutType[DateNanoType]

func NewDateNano 

func NewDateNano(c *Carbon) *DateNano

type DateNanoType added in v1.15.12 

type DateNanoType string

func (DateNanoType) Layout added in v1.15.12 

func (t DateNanoType) Layout() string

type DateTime 

type DateTime = carbon.LayoutType[DateTimeType]

func NewDateTime 

func NewDateTime(c *Carbon) *DateTime

type DateTimeMicro 

type DateTimeMicro = carbon.LayoutType[DateTimeMicroType]

func NewDateTimeMicro 

func NewDateTimeMicro(c *Carbon) *DateTimeMicro

type DateTimeMicroType added in v1.15.12 

type DateTimeMicroType string

func (DateTimeMicroType) Layout added in v1.15.12 

func (t DateTimeMicroType) Layout() string

type DateTimeMilli 

type DateTimeMilli = carbon.LayoutType[DateTimeMilliType]

func NewDateTimeMilli 

func NewDateTimeMilli(c *Carbon) *DateTimeMilli

type DateTimeMilliType added in v1.15.12 

type DateTimeMilliType string

func (DateTimeMilliType) Layout added in v1.15.12 

func (t DateTimeMilliType) Layout() string

type DateTimeNano 

type DateTimeNano = carbon.LayoutType[DateTimeNanoType]

func NewDateTimeNano 

func NewDateTimeNano(c *Carbon) *DateTimeNano

type DateTimeNanoType added in v1.15.12 

type DateTimeNanoType string

func (DateTimeNanoType) Layout added in v1.15.12 

func (t DateTimeNanoType) Layout() string

type DateTimeType added in v1.15.12 

type DateTimeType string

func (DateTimeType) Layout added in v1.15.12 

func (t DateTimeType) Layout() string

type DateType added in v1.15.12 

type DateType string

func (DateType) Layout added in v1.15.12 

func (t DateType) Layout() string

type Time added in v1.15.7 

type Time = carbon.LayoutType[TimeType]

func NewTime added in v1.15.7 

func NewTime(c *Carbon) *Time

type TimeMicro added in v1.15.7 

type TimeMicro = carbon.LayoutType[TimeMicroType]

func NewTimeMicro added in v1.15.7 

func NewTimeMicro(c *Carbon) *TimeMicro

type TimeMicroType added in v1.15.12 

type TimeMicroType string

func (TimeMicroType) Layout added in v1.15.12 

func (t TimeMicroType) Layout() string

type TimeMilli added in v1.15.7 

type TimeMilli = carbon.LayoutType[TimeMilliType]

func NewTimeMilli added in v1.15.7 

func NewTimeMilli(c *Carbon) *TimeMilli

type TimeMilliType added in v1.15.12 

type TimeMilliType string

func (TimeMilliType) Layout added in v1.15.12 

func (t TimeMilliType) Layout() string

type TimeNano added in v1.15.7 

type TimeNano = carbon.LayoutType[TimeNanoType]

func NewTimeNano added in v1.15.7 

func NewTimeNano(c *Carbon) *TimeNano

type TimeNanoType added in v1.15.12 

type TimeNanoType string

func (TimeNanoType) Layout added in v1.15.12 

func (t TimeNanoType) Layout() string

type TimeType added in v1.15.12 

type TimeType string

func (TimeType) Layout added in v1.15.12 

func (t TimeType) Layout() string

type Timestamp 

type Timestamp = carbon.TimestampType[TimestampType]

func NewTimestamp 

func NewTimestamp(c *Carbon) *Timestamp

type TimestampMicro 

type TimestampMicro = carbon.TimestampType[TimestampMicroType]

func NewTimestampMicro 

func NewTimestampMicro(c *Carbon) *TimestampMicro

type TimestampMicroType added in v1.15.12 

type TimestampMicroType int64

func (TimestampMicroType) Precision added in v1.15.12 

func (t TimestampMicroType) Precision() string

type TimestampMilli 

type TimestampMilli = carbon.TimestampType[TimestampMilliType]

func NewTimestampMilli 

func NewTimestampMilli(c *Carbon) *TimestampMilli

type TimestampMilliType added in v1.15.12 

type TimestampMilliType int64

func (TimestampMilliType) Precision added in v1.15.12 

func (t TimestampMilliType) Precision() string

type TimestampNano 

type TimestampNano = carbon.TimestampType[TimestampNanoType]

func NewTimestampNano 

func NewTimestampNano(c *Carbon) *TimestampNano

type TimestampNanoType added in v1.15.12 

type TimestampNanoType int64

func (TimestampNanoType) Precision added in v1.15.12 

func (t TimestampNanoType) Precision() string

type TimestampType added in v1.15.12 

type TimestampType int64

func (TimestampType) Precision added in v1.15.12 

func (t TimestampType) Precision() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.