package pgpassfile

Import Path
	github.com/jackc/pgpassfile (on go.dev)

Dependency Relation
	imports 5 packages, and imported by one package

Involved Source Files

	   d➜ pgpass.go
		Package pgpassfile is a parser PostgreSQL .pgpass files.
Package-Level Type Names (total 2, both are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Entry (struct)
		Entry represents a line in a PG passfile.

		Fields (total 5, all are exported)
			Database string
			Hostname string
			Password string
			Port string
			Username string
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func parseLine(line string) *Entry

	 type Passfile (struct)
		Passfile is the in memory data structure representing a PG passfile.

		Fields (only one, which is exported)
			Entries []*Entry
		Methods (only one, which is exported)
			(*T) FindPassword(hostname, port, database, username string) (password string)
				FindPassword finds the password for the provided hostname, port, database, and username. For a
				Unix domain socket hostname must be set to "localhost". An empty string will be returned if no
				match is found.

				See https://www.postgresql.org/docs/current/libpq-pgpass.html for more password file information.

		As Outputs Of (at least 2, both are exported)
			func ParsePassfile(r io.Reader) (*Passfile, error)
			func ReadPassfile(path string) (*Passfile, error)


Package-Level Functions (total 3, in which 2 are exported)

	 func ParsePassfile(r io.Reader) (*Passfile, error)
		ParsePassfile reads r and parses it into a Passfile.

	 func ReadPassfile(path string) (*Passfile, error)
		ReadPassfile reads the file at path and parses it into a Passfile.

	/* one unexported ... *//* one unexported: */
	 func parseLine(line string) *Entry
		parseLine parses a line into an *Entry. It returns nil on comment lines or any other unparsable
		line.


Package-Level Variables (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	  var colonSplitterRegexp *regexp.Regexp
		Match (not colons or escaped colon or escaped backslash)+. Essentially gives a split on unescaped
		colon.

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.