timeutil

package

v2.2.1 Latest Latest Go to latest Published: Apr 22, 2025 License: MIT Imports: 2 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

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

TimeUtil wraps a Carbon instance for chainable time utility operations.

func FromTime(t time.Time) *TimeUtil

FromTime creates a TimeUtil from a standard time.Time value.

func New() *TimeUtil

New returns a new TimeUtil initialized to the current time.

func Parse(dateStr string) (*TimeUtil, error)

Parse parses a date string into a TimeUtil instance. Returns an error if the string is not a valid date.

func (t *TimeUtil) AddDays(days int) *TimeUtil

AddDays adds the specified number of days and returns the updated TimeUtil.

func (t *TimeUtil) Carbon() *carbon.Carbon

Carbon returns the underlying Carbon pointer instance.

func (t *TimeUtil) DifferenceInDays(other *TimeUtil) int64

DifferenceInDays returns the number of days between this and another TimeUtil.

func (t *TimeUtil) EndOfWeek() *TimeUtil

EndOfWeek returns a new TimeUtil set to the end of the week.

func (t *TimeUtil) Format(layout string) string

Format formats the internal time using the given layout string.

func (t *TimeUtil) IsWeekend() bool

IsWeekend returns true if the current time is a weekend.

func (t *TimeUtil) StartOfWeek() *TimeUtil

StartOfWeek returns a new TimeUtil set to the beginning of the week.

func (t *TimeUtil) SubtractDays(days int) *TimeUtil

SubtractDays subtracts the specified number of days and returns the updated TimeUtil.

func (t *TimeUtil) ToTime() time.Time

ToTime returns the standard time.Time representation of the internal Carbon time.