summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/os/Stat.md
blob: 63cb3f26ae98dea15f4b5e738a49a0bb8c704451 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
---
title: os.Stat
description: Returns a FileInfo structure describing a file or directory.
categories: []
keywords: []
params:
  functions_and_methods:
    aliases: []
    returnType: os.FileInfo
    signatures: [os.Stat PATH]
aliases: [/functions/os.stat]
---

The `os.Stat` function attempts to resolve the path relative to the root of your project directory. If a matching file or directory is not found, it will attempt to resolve the path relative to the [`contentDir`](/configuration/all/#contentdir). A leading path separator (`/`) is optional.

```go-html-template
{{ $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)
```

Details of the `FileInfo` structure are available in the [Go documentation](https://pkg.go.dev/io/fs#FileInfo).