package util

Import Path
	github.com/prometheus/procfs/internal/util (on go.dev)

Dependency Relation
	imports 6 packages, and imported by one package

Involved Source Files

	      parse.go
	      readfile.go
	      sysreadfile_compat.go
	      valueparser.go
Package-Level Type Names (only one, which is exported)

	/* sort exporteds by: alphabet | popularity */
	 type ValueParser (struct)
		A ValueParser enables parsing a single string into a variety of data types
		in a concise and safe way. The Err method must be invoked after invoking
		any other methods to ensure a value was successfully parsed.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			err error
			v string
		Methods (total 5, in which 4 are exported)
			(*T) Err() error
				Err returns the last error, if any, encountered by the ValueParser.

			(*T) Int() int
				Int interprets the underlying value as an int and returns that value.

			(*T) PInt64() *int64
				PInt64 interprets the underlying value as an int64 and returns a pointer to
				that value.

			(*T) PUInt64() *uint64
				PUInt64 interprets the underlying value as an uint64 and returns a pointer to
				that value.

			/* one unexported ... *//* one unexported: */
			(*T) int64() int64
				int64 interprets the underlying value as an int64 and returns that value.
				TODO: export if/when necessary.

		As Outputs Of (at least one exported)
			func NewValueParser(v string) *ValueParser


Package-Level Functions (total 8, all are exported)

	 func NewValueParser(v string) *ValueParser
		NewValueParser creates a ValueParser using the input string.

	 func ParseBool(b string) *bool
		ParseBool parses a string into a boolean pointer.

	 func ParsePInt64s(ss []string) ([]*int64, error)
		ParsePInt64s parses a slice of strings into a slice of int64 pointers.

	 func ParseUint32s(ss []string) ([]uint32, error)
		ParseUint32s parses a slice of strings into a slice of uint32s.

	 func ParseUint64s(ss []string) ([]uint64, error)
		ParseUint64s parses a slice of strings into a slice of uint64s.

	 func ReadFileNoStat(filename string) ([]byte, error)
		ReadFileNoStat uses ioutil.ReadAll to read contents of entire file.
		This is similar to ioutil.ReadFile but without the call to os.Stat, because
		many files in /proc and /sys report incorrect file sizes (either 0 or 4096).
		Reads a max file size of 512kB.  For files larger than this, a scanner
		should be used.

	 func ReadUintFromFile(path string) (uint64, error)
		ReadUintFromFile reads a file and attempts to parse a uint64 from it.

	 func SysReadFile(file string) (string, error)
		SysReadFile is here implemented as a noop for builds that do not support
		the read syscall. For example Windows, or Linux on Google App Engine.

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.