times

README

times

Usage

File Times for #golang

Go has a hidden time functions for most platforms, this repo makes them accessible.

package main

import (
  "log"

  "github.com/djherbis/times"
)

func main() {
  t, err := times.Stat("myfile")
  if err != nil {
    log.Fatal(err.Error())
  }

  log.Println(t.AccessTime())
  log.Println(t.ModTime())

  if t.HasChangeTime() {
    log.Println(t.ChangeTime())
  }

  if t.HasBirthTime() {
    log.Println(t.BirthTime())
  }
}

Supported Times

	windows	linux	solaris	dragonfly	nacl	freebsd	darwin	netbsd	openbsd	plan9	js	aix
atime	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
mtime	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
ctime	✓*	✓	✓	✓	✓	✓	✓	✓	✓		✓	✓
btime	✓	✓*				✓	✓	✓

• Linux btime requires kernel 4.11 and filesystem support, so HasBirthTime = false. Use Timespec.HasBirthTime() to check if file has birth time. Get(FileInfo) never returns btime.
• Windows XP does not have ChangeTime so HasChangeTime = false, however Vista onward does have ChangeTime so Timespec.HasChangeTime() will only return false on those platforms when the syscall used to obtain them fails.
• Also note, Get(FileInfo) will now only return values available in FileInfo.Sys(), this means Stat() is required to get ChangeTime on Windows

Installation

go get -u github.com/djherbis/times

Documentation

Overview

Package times provides a platform-independent way to get atime, mtime, ctime and btime for files.

Index

• Constants
• type Timespec
  • func Get(fi os.FileInfo) Timespec
  • func Lstat(name string) (Timespec, error)
  • func Stat(name string) (Timespec, error)
  • func StatFile(file *os.File) (Timespec, error)

Constants

const (
	HasChangeTime = true
	HasBirthTime  = false
)

HasChangeTime and HasBirthTime are true if and only if the target OS supports them.

Types

type Timespec

type Timespec interface {
	ModTime() time.Time
	AccessTime() time.Time
	ChangeTime() time.Time
	BirthTime() time.Time
	HasChangeTime() bool
	HasBirthTime() bool
}

Timespec provides access to file times. ChangeTime() panics unless HasChangeTime() is true and BirthTime() panics unless HasBirthTime() is true.

func Get

func Get(fi os.FileInfo) Timespec

Get returns the Timespec for the given FileInfo

func Lstat

func Lstat(name string) (Timespec, error)

Lstat returns the Timespec for the given filename, and does not follow Symlinks.

func Stat

func Stat(name string) (Timespec, error)

Stat returns the Timespec for the given filename.

func StatFile

func StatFile(file *os.File) (Timespec, error)

StatFile returns the Timespec for the given *os.File.