package revision

Import Path
	github.com/go-git/go-git/v5/internal/revision (on go.dev)

Dependency Relation
	imports 8 packages, and imported by one package

Involved Source Files

	   d➜ parser.go
		Package revision extracts git revision from string
		More information about revision : https://www.kernel.org/pub/software/scm/git/docs/gitrevisions.html

	      scanner.go
	      token.go
Package-Level Type Names (total 19, in which 16 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type AtCheckout (struct)
		AtCheckout represents @{-n}

		Fields (only one, which is exported)
			Depth int

	 type AtDate (struct)
		AtDate represents @{"2006-01-02T15:04:05Z"}

		Fields (only one, which is exported)
			Date time.Time

	 type AtPush (struct)
		AtPush represents @{push}

		Fields (only one, which is exported)
			BranchName string

	 type AtReflog (struct)
		AtReflog represents @{n}

		Fields (only one, which is exported)
			Depth int

	 type AtUpstream (struct)
		AtUpstream represents @{upstream}, @{u}

		Fields (only one, which is exported)
			BranchName string

	 type CaretPath (struct)
		CaretPath represents ^, ^{n}

		Fields (only one, which is exported)
			Depth int

	 type CaretReg (struct)
		CaretReg represents ^{/foo bar}

		Fields (total 2, both are exported)
			Negate bool
			Regexp *regexp.Regexp

	 type CaretType (struct)
		CaretType represents ^{commit}

		Fields (only one, which is exported)
			ObjectType string

	 type ColonPath (struct)
		ColonPath represents :./<path> :<path>

		Fields (only one, which is exported)
			Path string

	 type ColonReg (struct)
		ColonReg represents :/foo bar

		Fields (total 2, both are exported)
			Negate bool
			Regexp *regexp.Regexp

	 type ColonStagePath (struct)
		ColonStagePath represents :<n>:/<path>

		Fields (total 2, both are exported)
			Path string
			Stage int

	 type ErrInvalidRevision (struct)
		ErrInvalidRevision is emitted if string doesn't match valid revision

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			s string
		Methods (only one, which is exported)
			(*T) Error() string
		Implements (at least one exported)
			*T : error

	 type Parser (struct)
		Parser represents a parser
		use to tokenize and transform to revisioner chunks
		a given string

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			currentParsedChar struct{tok token; lit string}
			s *scanner
			unreadLastChar bool
		Methods (total 13, in which 1 are exported)
			(*T) Parse() ([]Revisioner, error)
				Parse explode a revision string into revisioner chunks

			/* 12 unexporteds ... *//* 12 unexporteds: */
			(*T) checkRefFormat(token token, literal string, previousToken token, buffer string, endOfRef bool) error
				checkRefFormat ensure reference name follow rules defined here :
				https://git-scm.com/docs/git-check-ref-format

			(*T) parseAt() (Revisioner, error)
				parseAt extract @ statements

			(*T) parseCaret() (Revisioner, error)
				parseCaret extract ^ statements

			(*T) parseCaretBraces() (Revisioner, error)
				parseCaretBraces extract ^{<data>} statements

			(*T) parseColon() (Revisioner, error)
				parseColon extract : statements

			(*T) parseColonDefault() (Revisioner, error)
				parseColonDefault extract :<data> statements

			(*T) parseColonSlash() (Revisioner, error)
				parseColonSlash extract :/<data> statements

			(*T) parseRef() (Revisioner, error)
				parseRef extract reference name

			(*T) parseTilde() (Revisioner, error)
				parseTilde extract ~ statements

			(*T) scan() (token, string, error)
				scan returns the next token from the underlying scanner
				or the last scanned token if an unscan was requested

			(*T) unscan()
				unscan pushes the previously read token back onto the buffer.

			(*T) validateFullRevision(chunks *[]Revisioner) error
				validateFullRevision ensures all revisioner chunks make a valid revision

		As Outputs Of (at least 2, both are exported)
			func NewParser(r io.Reader) *Parser
			func NewParserFromString(s string) *Parser

	 type Ref string (basic type)
		Ref represents a reference name : HEAD, master


	 type Revisioner (interface)
		Revisioner represents a revision component.
		A revision is made of multiple revision components
		obtained after parsing a revision string,
		for instance revision "master~" will be converted in
		two revision components Ref and TildePath

		As Outputs Of (at least 9, in which 1 are exported)
			func (*Parser).Parse() ([]Revisioner, error)
			/* 8+ unexporteds ... *//* 8+ unexporteds: */
			func (*Parser).parseAt() (Revisioner, error)
			func (*Parser).parseCaret() (Revisioner, error)
			func (*Parser).parseCaretBraces() (Revisioner, error)
			func (*Parser).parseColon() (Revisioner, error)
			func (*Parser).parseColonDefault() (Revisioner, error)
			func (*Parser).parseColonSlash() (Revisioner, error)
			func (*Parser).parseRef() (Revisioner, error)
			func (*Parser).parseTilde() (Revisioner, error)
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func (*Parser).validateFullRevision(chunks *[]Revisioner) error

	 type TildePath (struct)
		TildePath represents ~, ~{n}

		Fields (only one, which is exported)
			Depth int

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 type runeCategoryValidator (func)
		runeCategoryValidator takes a rune as input and
		validates it belongs to a rune category

		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func tokenizeExpression(ch rune, tokenType token, check runeCategoryValidator, r *bufio.Reader) (token, string, error)

	 type scanner (struct)
		scanner represents a lexical scanner.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			r *bufio.Reader
		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			(*T) scan() (token, string, error)
				Scan extracts tokens and their strings counterpart
				from the reader

		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func newScanner(r io.Reader) *scanner

	 type token int (basic type)
		token represents a entity extracted from string parsing

		As Outputs Of (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func tokenizeExpression(ch rune, tokenType token, check runeCategoryValidator, r *bufio.Reader) (token, string, error)
			func (*Parser).scan() (token, string, error)
		As Inputs Of (at least 3, none are exported)
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			func tokenizeExpression(ch rune, tokenType token, check runeCategoryValidator, r *bufio.Reader) (token, string, error)
			func (*Parser).checkRefFormat(token token, literal string, previousToken token, buffer string, endOfRef bool) error
			func (*Parser).checkRefFormat(token token, literal string, previousToken token, buffer string, endOfRef bool) error
		As Types Of (total 20, none are exported)
			/* 20 unexporteds ... *//* 20 unexporteds: */
			const aslash
			const asterisk
			const at
			const caret
			const cbrace
			const colon
			const control
			const dot
			const emark
			const eof
			const minus
			const number
			const obrace
			const obracket
			const qmark
			const slash
			const space
			const tilde
			const tokenError
			const word


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

	 func NewParser(r io.Reader) *Parser
		NewParser returns a new instance of parser.

	 func NewParserFromString(s string) *Parser
		NewParserFromString returns a new instance of parser from a string.

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 func newScanner(r io.Reader) *scanner
		newScanner returns a new instance of scanner.

	 func tokenizeExpression(ch rune, tokenType token, check runeCategoryValidator, r *bufio.Reader) (token, string, error)
		tokenizeExpression aggregates a series of runes matching check predicate into a single
		string and provides given tokenType as token type


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

	/* one unexported ... *//* one unexported: */
	  var zeroRune rune
Package-Level Constants (total 20, none are exported)

	/* 20 unexporteds ... *//* 20 unexporteds: */
	const aslash token = 1
	const asterisk token = 2
	const at token = 3
	const caret token = 4
	const cbrace token = 5
	const colon token = 6
	const control token = 7
	const dot token = 8
	const emark token = 9
	const eof token = 0
	const minus token = 10
	const number token = 11
	const obrace token = 12
	const obracket token = 13
	const qmark token = 14
	const slash token = 15
	const space token = 16
	const tilde token = 17
	const tokenError token = 18
	const word token = 19

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.