persian

Documentation

Overview

Package persian is part of the carbon package.

Index

• Variables
• type Locale
• type Persian
  • func FromStdTime(t time.Time) (p *Persian)
  • func NewPersian(year, month, day int) *Persian
  • func (p *Persian) Day() int
  • func (p *Persian) IsLeapYear() bool
  • func (p *Persian) IsValid() bool
  • func (p *Persian) Month() int
  • func (p *Persian) String() string
  • func (p *Persian) ToGregorian(timezone ...string) *calendar.Gregorian
  • func (p *Persian) ToMonthString(locale ...Locale) (month string)
  • func (p *Persian) ToWeekString(locale ...Locale) (month string)
  • func (p *Persian) Year() int

Variables

var (
	EnMonths = []string{"Farvardin", "Ordibehesht", "Khordad", "Tir", "Mordad", "Shahrivar", "Mehr", "Aban", "Azar", "Dey", "Bahman", "Esfand"}
	FaMonths = []string{"فروردین", "اردیبهشت", "خرداد", "تیر", "مرداد", "شهریور", "مهر", "آبان", "آذر", "دی", "بهمن", "اسفند"}

	EnWeeks = []string{"Yekshanbeh", "Doshanbeh", "Seshanbeh", "Chaharshanbeh", "Panjshanbeh", "Jomeh", "Shanbeh"}
	FaWeeks = []string{"نجشنبه", "دوشنبه", "سه شنبه", "چهارشنبه", "پنجشنبه", "جمعه", "شنبه"}
)

Types

type Locale

type Locale string

const (
	EnLocale Locale = "en"
	FaLocale Locale = "fa"
)

type Persian

type Persian struct {
	Error error
	// contains filtered or unexported fields
}

Persian defines a Persian struct.

func FromStdTime

func FromStdTime(t time.Time) (p *Persian)

FromStdTime creates a Persian instance from standard time.Time.

func NewPersian

func NewPersian(year, month, day int) *Persian

NewPersian returns a new Persian instance.

func (*Persian) Day

func (p *Persian) Day() int

Day gets the Persian day like 5.

func (*Persian) IsLeapYear

func (p *Persian) IsLeapYear() bool

IsLeapYear reports whether the Persian year is a leap year.

func (*Persian) IsValid

func (p *Persian) IsValid() bool

IsValid reports whether the Persian date is valid.

func (*Persian) Month

func (p *Persian) Month() int

Month gets the Persian month like 8.

func (*Persian) String

func (p *Persian) String() string

String implements the "Stringer" interface for Persian.

func (*Persian) ToGregorian

func (p *Persian) ToGregorian(timezone ...string) *calendar.Gregorian

ToGregorian converts Persian instance to Gregorian instance.

func (*Persian) ToMonthString

func (p *Persian) ToMonthString(locale ...Locale) (month string)

ToMonthString outputs a string in Persian month format like "فروردین".

func (*Persian) ToWeekString

func (p *Persian) ToWeekString(locale ...Locale) (month string)

ToWeekString outputs a string in week layout like "چهارشنبه".

func (*Persian) Year

func (p *Persian) Year() int

Year gets the Persian year like 2020.