Package jalaali

import "github.com/jalaali/go-jalaali"

Overview
Index

Overview

Index

func IsLeapYear(jy int) (bool, error)
func IsValidDate(jy, jm, jd int) bool
func MonthLength(jy, jm int) (int, error)
func ToGregorian(jalaaliYear int, jalaaliMonth Month, jalaaliDay int) (int, time.Month, int, error)
type ErrorInvalidYear
func (e *ErrorInvalidYear) Error() string
type ErrorNilReference
func (e *ErrorNilReference) Error() string
type Jalaali
func From(t time.Time) Jalaali
func Now() Jalaali
func (j Jalaali) JFormat(layout string) (string, error)
type Month
func ToJalaali(gregorianYear int, gregorianMonth time.Month, gregorianDay int) (int, Month, int, error)
func (m Month) String() string
type Weekday
func (d Weekday) String() string

Package files

convertion.go errors.go format.go jalaali.go utils.go

func IsLeapYear

func IsLeapYear(jy int) (bool, error)

IsLeapYear take a Jalaali year and return true if it is leap year. Error is not nil if Jalaali year passed to function is not valid.

func IsValidDate

func IsValidDate(jy, jm, jd int) bool

IsValidDate take Jalaali date and return true if it is valid, otherwise false.

func MonthLength

func MonthLength(jy, jm int) (int, error)

MonthLength take Jalaali date and return length of that specific month. Error is not nil if Jalaali year passed to function is not valid.

func ToGregorian

func ToGregorian(jalaaliYear int, jalaaliMonth Month, jalaaliDay int) (int, time.Month, int, error)

ToGregorian converts Jalaali to Gregorian date. Error is not nil if Jalaali year passed to function is not valid.

type ErrorInvalidYear

ErrorInvalidYear is happening when year passed is is in proper range.

type ErrorInvalidYear struct {
    // contains filtered or unexported fields
}

func (*ErrorInvalidYear) Error

func (e *ErrorInvalidYear) Error() string

type ErrorNilReference

ErrorNilReference is happening when a pointer is nil.

type ErrorNilReference struct{}

func (*ErrorNilReference) Error

func (e *ErrorNilReference) Error() string

type Jalaali

A simple wrapper around Golang default time package. You have all the functionality of default time package and functionalities needed for Jalaali calender.

type Jalaali struct {
    time.Time
}

func From

func From(t time.Time) Jalaali

From initialize new instance of Jalaali from a time instance.

func Now

func Now() Jalaali

Now with return Jalaali instance of current time.

func (Jalaali) JFormat

func (j Jalaali) JFormat(layout string) (string, error)

JFormat gets default Golang layout string and parse put Jalaali calender information into the final string and return it.

type Month

A Month specifies a month of the year (Farvardin = 1, ...).

type Month int

const (
    Farvardin Month = 1 + iota
    Ordibehesht
    Khordad
    Tir
    Mordad
    Shahrivar
    Mehr
    Aban
    Azar
    Dey
    Bahman
    Esfand
)

func ToJalaali

func ToJalaali(gregorianYear int, gregorianMonth time.Month, gregorianDay int) (int, Month, int, error)

ToJalaali converts Gregorian to Jalaali date. Error is not nil if Jalaali year passed to function is not valid.

func (Month) String

func (m Month) String() string

type Weekday

A Weekday specifies a day of the week (Shanbe = 0, ...).

type Weekday int

const (
    Shanbe Weekday = iota
    IekShanbe
    DoShanbe
    SeShanbe
    ChaharShanbe
    PanjShanbe
    Jome
)

func (Weekday) String

func (d Weekday) String() string

github.com/jalaali/go-jalaali

Jalaali

Installation

Usage