package format

Import Path
	golang.org/x/text/internal/format (on go.dev)

Dependency Relation
	imports 4 packages, and imported by 2 packages

Involved Source Files

	  d format.go
		Package format contains types for defining language-specific formatting of
		values.
		
		This package is internal now, but will eventually be exposed after the API
		settles.

	    parser.go
Package-Level Type Names (total 4)

	/* sort by: alphabet | popularity */
	 type Formatter (interface)
		Formatter is analogous to fmt.Formatter.

		Methods (only one)
			( Formatter) Format(state State, verb rune)
		Implemented By (at least one exported)
			 golang.org/x/text/number.Formatter

	 type Parser (struct)
		A Parser parses a format string. The result from the parse are set in the
		struct fields.

		Fields (total 17)
			ArgNum int
				retain current argument number across calls

			Args []interface{}
				retain arguments across calls.

			HasIndex bool
			Minus bool
			Plus bool
			PlusV bool
				For the formats %+v %#v, we set the plusV/sharpV flags
				and clear the plus/sharp flags since %+v and %#v are in effect
				different, flagless formats set at the top level.

			Prec int
				// precision

			PrecPresent bool
			Reordered bool
				reordered records whether the format string used argument reordering.

			Sharp bool
			SharpV bool
			Space bool
			Status Status
			Verb rune
			Width int
			WidthPresent bool
			Zero bool
		Methods (total 5)
			(*Parser) ClearFlags()
				ClearFlags reset the parser to default behavior.

			(*Parser) Reset(args []interface{})
				Reset initializes a parser to scan format strings for the given args.

			(*Parser) Scan() bool
				Scan scans the next part of the format string and sets the status to
				indicate whether it scanned a string literal, substitution or error.

			(*Parser) SetFormat(format string)
				SetFormat sets a new format string to parse. It does not reset the argument
				count.

			(*Parser) Text() string
				Text returns the part of the format string that was parsed by the last call
				to Scan. It returns the original substitution clause if the current scan
				parsed a substitution.


	 type State (interface)
		State represents the printer state passed to custom formatters. It provides
		access to the fmt.State interface and the sentence and language-related
		context.

		Methods (total 5)
			( State) Flag(c int) bool
				Flag reports whether the flag c, a character, has been set.

			( State) Language() language.Tag
				Language reports the requested language in which to render a message.

			( State) Precision() (prec int, ok bool)
				Precision returns the value of the precision option and whether it has been set.

			( State) Width() (wid int, ok bool)
				Width returns the value of the width option and whether it has been set.

			( State) Write(b []byte) (n int, err error)
				Write is the function to call to emit formatted output to be printed.

		Implements (at least 4)
			 State : fmt.State
			 State : github.com/miekg/dns.Writer
			 State : internal/bisect.Writer
			 State : io.Writer
		As Inputs Of (at least 2)
			func Formatter.Format(state State, verb rune)
			func golang.org/x/text/number.Formatter.Format(state State, verb rune)

	 type Status int (basic type)
		Status indicates the result type of a call to Scan.

		As Types Of (total 7)
			const StatusBadArgNum
			const StatusBadPrecSubstitution
			const StatusBadWidthSubstitution
			const StatusMissingArg
			const StatusNoVerb
			const StatusSubstitution
			const StatusText


Package-Level Constants (total 7)

	const StatusBadArgNum Status = 5
	const StatusBadPrecSubstitution Status = 3
	const StatusBadWidthSubstitution Status = 2
	const StatusMissingArg Status = 6
	const StatusNoVerb Status = 4
	const StatusSubstitution Status = 1
	const StatusText Status = 0

The pages are generated with Golds v0.8.2. (GOOS=linux 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 @zigo_101 (reachable from the left QR code) to get the latest news of Golds.