package stack

Import Path
	go.uber.org/goleak/internal/stack (on go.dev)

Dependency Relation
	imports 8 packages, and imported by one package

Involved Source Files

	  d doc.go
		Package stack is used for parsing stacks from `runtime.Stack`.

	    scan.go
	    stacks.go
Package-Level Type Names (total 3, in which 1 is exported)

	/* sort exporteds by: alphabet | popularity */
	 type Stack (struct)
		Stack represents a single Goroutine's stack.

		Fields (total 5, none are exported)
			/* 5 unexporteds ... *//* 5 unexporteds: */
			allFunctions map[string]struct{}
				A set of all functions in the stack,

			firstFunction string
				The first function on the stack.

			fullStack string
				Full, raw stack trace.

			id int
			state string
				// e.g. 'running', 'chan receive'

		Methods (total 6, all are exported)
			( Stack) FirstFunction() string
				FirstFunction returns the name of the first function on the stack.

			( Stack) Full() string
				Full returns the full stack trace for this goroutine.

			( Stack) HasFunction(name string) bool
				HasFunction reports whether the stack has the given function
				anywhere in it.

			( Stack) ID() int
				ID returns the goroutine ID.

			( Stack) State() string
				State returns the Goroutine's state.

			( Stack) String() string
		Implements (at least 4, in which 2 are exported)
			 Stack : expvar.Var
			 Stack : fmt.Stringer
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 Stack : context.stringer
			 Stack : runtime.stringer
		As Outputs Of (at least 4, in which 2 are exported)
			func All() []Stack
			func Current() Stack
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func getStacks(all bool) []Stack
			func go.uber.org/goleak.filterStacks(stacks []Stack, skipID int, opts *goleak.opts) []Stack
		As Inputs Of (at least 5, none are exported)
			/* 5+ unexporteds ... *//* 5+ unexporteds: */
			func go.uber.org/goleak.filterStacks(stacks []Stack, skipID int, opts *goleak.opts) []Stack
			func go.uber.org/goleak.isStdLibStack(s Stack) bool
			func go.uber.org/goleak.isSyscallStack(s Stack) bool
			func go.uber.org/goleak.isTestStack(s Stack) bool
			func go.uber.org/goleak.isTraceStack(s Stack) bool

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 type scanner (struct)
		scanner provides a bufio.Scanner the ability to Unscan,
		which allows the current token to be read again
		after the next Scan.

		Fields (total 13, in which 1 is exported)
			Scanner *bufio.Scanner
			/* 12 unexporteds ... *//* 12 unexporteds: */
			Scanner.buf []byte
				// Buffer used as argument to split.

			Scanner.done bool
				// Scan has finished.

			Scanner.empties int
				// Count of successive empty tokens.

			Scanner.end int
				// End of data in buf.

			Scanner.err error
				// Sticky error.

			Scanner.maxTokenSize int
				// Maximum size of a token; modified by tests.

			Scanner.r io.Reader
				// The reader provided by the client.

			Scanner.scanCalled bool
				// Scan has been called; buffer is in use.

			Scanner.split bufio.SplitFunc
				// The function to split the tokens.

			Scanner.start int
				// First non-processed byte in buf.

			Scanner.token []byte
				// Last token returned by split.

			unscanned bool
		Methods (total 9, in which 7 are exported)
			( scanner) Buffer(buf []byte, max int)
				Buffer sets the initial buffer to use when scanning
				and the maximum size of buffer that may be allocated during scanning.
				The maximum token size must be less than the larger of max and cap(buf).
				If max <= cap(buf), [Scanner.Scan] will use this buffer only and do no allocation.
				
				By default, [Scanner.Scan] uses an internal buffer and sets the
				maximum token size to [MaxScanTokenSize].
				
				Buffer panics if it is called after scanning has started.

			( scanner) Bytes() []byte
				Bytes returns the most recent token generated by a call to [Scanner.Scan].
				The underlying array may point to data that will be overwritten
				by a subsequent call to Scan. It does no allocation.

			( scanner) Err() error
				Err returns the first non-EOF error that was encountered by the [Scanner].

			(*scanner) Scan() bool
			( scanner) Split(split bufio.SplitFunc)
				Split sets the split function for the [Scanner].
				The default split function is [ScanLines].
				
				Split panics if it is called after scanning has started.

			( scanner) Text() string
				Text returns the most recent token generated by a call to [Scanner.Scan]
				as a newly allocated string holding its bytes.

			(*scanner) Unscan()
				Unscan stops the scanner from advancing its position
				for the next Scan.
				
				Bytes and Text will return the same token after next Scan
				that they do right now.

			/* 2 unexporteds ... *//* 2 unexporteds: */
			( scanner) advance(n int) bool
				advance consumes n bytes of the buffer. It reports whether the advance was legal.

			( scanner) setErr(err error)
				setErr records the first error encountered.

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

	 type stackParser (struct)

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			errors []error
			scan *scanner
			stacks []Stack
		Methods (total 2, in which 1 is exported)
			(*stackParser) Parse() ([]Stack, error)
			/* one unexported ... *//* one unexported: */
			(*stackParser) parseStack(line string) (Stack, error)
				parseStack parses a single stack trace from the given scanner.
				line is the first line of the stack trace, which should look like:
				
					goroutine 123 [runnable]:

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


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

	 func All() []Stack
		All returns the stacks for all running goroutines.

	 func Current() Stack
		Current returns the stack for the current goroutine.

	/* 6 unexporteds ... *//* 6 unexporteds: */
	 func getStackBuffer(all bool) []byte
	 func getStacks(all bool) []Stack
	 func newScanner(r io.Reader) *scanner
	 func newStackParser(r io.Reader) *stackParser
	 func parseFuncName(line string) (name string, creator bool, err error)
		Parses a single function from the given line.
		The line is in one of these formats:
		
			example.com/path/to/package.funcName(args...)
			example.com/path/to/package.(*typeName).funcName(args...)
			created by example.com/path/to/package.funcName
			created by example.com/path/to/package.funcName in goroutine [...]
		
		Also reports whether the line was a "created by" line.

	 func parseGoStackHeader(line string) (goroutineID int, state string, err error)
		parseGoStackHeader parses a stack header that looks like:
		goroutine 643 [runnable]:\n
		And returns the goroutine ID, and the state.


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

	/* one unexported ... *//* one unexported: */
	const _defaultBufferSize = 65536 // 64 KiB

The pages are generated with Golds v0.7.6. (GOOS=linux GOARCH=amd64)