diff options
Diffstat (limited to 'docs/content/en/functions/os.Stat.md')
| -rw-r--r-- | docs/content/en/functions/os.Stat.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/content/en/functions/os.Stat.md b/docs/content/en/functions/os.Stat.md new file mode 100644 index 000000000..a56f79735 --- /dev/null +++ b/docs/content/en/functions/os.Stat.md @@ -0,0 +1,32 @@ +--- +title: os.Stat +description: Returns a FileInfo structure describing a file or directory. +date: 2018-08-07 +publishdate: 2018-08-07 +lastmod: 2021-11-26 +categories: [functions] +menu: + docs: + parent: "functions" +keywords: [files] +signature: ["os.Stat PATH"] +workson: [] +hugoversion: +relatedfuncs: ['os.FileExists','os.ReadDir','os.ReadFile'] +deprecated: false +aliases: [] +--- +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`]({{< relref "getting-started/configuration#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). |