filesystem

Documentation

Overview

Package filesystem returns information about available filesystems.

Index

• Variables
• type Info
  • func CollectInfo() (Info, error)
  • func (mounts Info) AsJSON() (interface{}, []string, error)
• type MountInfo

Variables

var (

	// ErrTimeoutExceeded represents a timeout error
	ErrTimeoutExceeded = errors.New("timeout exceeded")
)

Types

type Info

type Info []MountInfo

Info represents a list of mounted filesystems.

func CollectInfo

func CollectInfo() (Info, error)

CollectInfo returns the list of mounted filesystems

func (Info) AsJSON

func (mounts Info) AsJSON() (interface{}, []string, error)

Collect returns the list of mounted filesystems as an object which can be used to generate a JSON

type MountInfo

type MountInfo struct {
	// Name is the name of the mounted filesystem.
	Name string `json:"name"`
	// SizeKB is the size of the mounted filesystem in KB.
	SizeKB uint64 `json:"kb_size"`
	// MountedOn is the mount point path of the mounted filesystem.
	MountedOn string `json:"mounted_on"`
}

MountInfo represents a mounted filesystem.