Working with File Metadata in Go

Table of Contents

  1. Introduction
  2. Prerequisites
  3. Setup
  4. Getting File Metadata
  5. Modifying File Metadata
  6. Conclusion

Introduction

In this tutorial, we will learn how to work with file metadata in Go. File metadata includes information such as file size, permissions, modification time, and so on. By the end of this tutorial, you will be able to retrieve and modify file metadata using Go programming language.

Prerequisites

Before you start this tutorial, you should have a basic understanding of Go programming language and have Go installed on your machine.

Setup

To follow along with this tutorial, create a new Go file called file_metadata.go and open it in your favorite text editor.

Getting File Metadata

To retrieve file metadata in Go, we can use the os.Stat() function. This function returns a FileInfo structure that contains various methods to access different file metadata.

Let’s start by writing a function that retrieves and displays the file metadata:

package main

import (
	"fmt"
	"os"
)

func getFileMetadata(filename string) {
	info, err := os.Stat(filename)
	if err != nil {
		fmt.Println("Error:", err)
		return
	}

	fmt.Println("File Name:", info.Name())
	fmt.Println("Size (in bytes):", info.Size())
	fmt.Println("Permissions:", info.Mode().String())
	fmt.Println("Last Modified:", info.ModTime())
	fmt.Println("Is Directory?", info.IsDir())
}

In this code, we first use os.Stat() to get the file information and handle any potential errors. Then, we use various methods of the FileInfo structure to access different metadata:

  • Name() returns the name of the file.
  • Size() returns the size of the file in bytes.
  • Mode() returns the file permissions as an os.FileMode type. We convert it to a string using String() method.
  • ModTime() returns the last modification time of the file.
  • IsDir() returns whether the file is a directory or not.

To test our function, we can call it with a file name as the argument:

func main() {
	getFileMetadata("example.txt")
}

Ensure that you have a file named example.txt in the same directory as your Go file. Running the program will display the metadata of the example.txt file.

Modifying File Metadata

In addition to retrieving file metadata, we can also modify certain attributes such as permissions and timestamps using the os.Chtimes() and os.Chmod() functions.

Let’s see an example of modifying file metadata:

package main

import (
	"fmt"
	"os"
	"time"
)

func modifyFileMetadata(filename string) {
	err := os.Chtimes(filename, time.Now(), time.Date(2022, time.January, 1, 0, 0, 0, 0, time.UTC))
	if err != nil {
		fmt.Println("Error:", err)
		return
	}

	err = os.Chmod(filename, 0644)
	if err != nil {
		fmt.Println("Error:", err)
		return
	}

	fmt.Println("File metadata modified successfully!")
}

In this code, we use os.Chtimes() to change the access and modification timestamps of a file. We pass the filename, the new access time (current time using time.Now()), and the new modification time (January 1, 2022, 00:00:00 UTC).

Then, we use os.Chmod() to change the permissions of the file. We pass the filename and the desired permissions in octal format (0644).

To test our function, we can call it with a file name as the argument:

func main() {
	modifyFileMetadata("example.txt")
}

Ensure that you have the same example.txt file created earlier. Running the program will modify the access and modification timestamps to the current time and set the permissions to 0644.

Conclusion

In this tutorial, we have learned how to work with file metadata in Go. We have seen how to retrieve and display file metadata using the os.Stat() function and the corresponding FileInfo methods. Additionally, we have explored how to modify file metadata by using os.Chtimes() and os.Chmod() functions.

By understanding and manipulating file metadata, you can build more powerful file handling applications in Go.

Published:

Related Articles