os.Stat
Returns a FileInfo object describing a file or directory.
- Syntax
- os.Stat PATH
- Returns
- os.FileInfo
Usage
The os.Stat function returns a FileInfo object describing the file or directory at the given PATH. The function resolves the path relative to the root of your project directory, then relative to the root of each module. If it does not find a matching file or directory, it resolves the path relative to the content directory of the unified file system. A leading path separator (/) is optional.
The FileInfo object has methods such as IsDir, ModTime, Name, and Size, as described in the Go documentation. If the file or directory does not exist, the function returns nil.
Examples
{{ $f := os.Stat "README.md" }}
{{ $f.IsDir }} → false (bool)
{{ $f.ModTime }} → 2021-11-25 10:06:49.315429236 -0800 PST (time.Time)
{{ $f.Name }} → README.md (string)
{{ $f.Size }} → 241 (int64)
{{ $d := os.Stat "content" }}
{{ $d.IsDir }} → true (bool)Checking whether a file exists before accessing its methods:
{{ with os.Stat "README.md" }}
{{ .Size }} → 241
{{ end }}Last updated:
November 8, 2026
:
content: Remove categories from front matter (1cc1dd83a)
Improve this page