package util

Import Path
	github.com/yuin/goldmark/util (on go.dev)

Dependency Relation
	imports 10 packages, and imported by 10 packages

Involved Source Files

	      html5entities.go
	      unicode_case_folding.go
	   d➜ util.go
		Package util provides utility functions for the goldmark.

	      util_unsafe.go
Package-Level Type Names (total 7, in which 6 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type BufWriter (interface)
		A BufWriter is a subset of the bufio.Writer .

		Methods (total 7, all are exported)
			( T) Available() int
			( T) Buffered() int
			( T) Flush() error
			( T) Write(p []byte) (n int, err error)
			( T) WriteByte(c byte) error
			( T) WriteRune(r rune) (size int, err error)
			( T) WriteString(s string) (int, error)
		Implemented By (at least 3, in which 2 are exported)
			*bufio.Writer
			 net/http/internal.FlushAfterChunkWriter
			/* at least one unexported ... *//* at least one unexported: */
			 encoding/xml.printer
		Implements (at least 11, in which 5 are exported)
			 T : github.com/go-git/go-git/v5/plumbing/protocol/packp/sideband.Progress
			 T : github.com/jbenet/go-context/io.Writer
			 T : io.ByteWriter
			 T : io.StringWriter
			 T : io.Writer
			/* 6+ unexporteds ... *//* 6+ unexporteds: */
			 T : github.com/go-redis/redis/v8/internal/proto.writer
			 T : github.com/prometheus/common/expfmt.enhancedWriter
			 T : golang.org/x/net/html.writer
			 T : golang.org/x/net/http2.stringWriter
			 T : image/jpeg.writer
			 T : net/http.http2stringWriter
		As Inputs Of (at least 39, in which 3 are exported)
			func github.com/yuin/goldmark/renderer/html.RenderAttributes(w BufWriter, node ast.Node, filter BytesFilter)
			func github.com/yuin/goldmark/renderer/html.Writer.RawWrite(writer BufWriter, source []byte)
			func github.com/yuin/goldmark/renderer/html.Writer.Write(writer BufWriter, source []byte)
			/* 36+ unexporteds ... *//* 36+ unexporteds: */
			func github.com/yuin/goldmark/extension.(*DefinitionListHTMLRenderer).renderDefinitionDescription(w BufWriter, source []byte, node gast.Node, entering bool) (gast.WalkStatus, error)
			func github.com/yuin/goldmark/extension.(*DefinitionListHTMLRenderer).renderDefinitionList(w BufWriter, source []byte, n gast.Node, entering bool) (gast.WalkStatus, error)
			func github.com/yuin/goldmark/extension.(*DefinitionListHTMLRenderer).renderDefinitionTerm(w BufWriter, source []byte, n gast.Node, entering bool) (gast.WalkStatus, error)
			func github.com/yuin/goldmark/extension.(*FootnoteHTMLRenderer).renderFootnote(w BufWriter, source []byte, node gast.Node, entering bool) (gast.WalkStatus, error)
			func github.com/yuin/goldmark/extension.(*FootnoteHTMLRenderer).renderFootnoteBacklink(w BufWriter, source []byte, node gast.Node, entering bool) (gast.WalkStatus, error)
			func github.com/yuin/goldmark/extension.(*FootnoteHTMLRenderer).renderFootnoteLink(w BufWriter, source []byte, node gast.Node, entering bool) (gast.WalkStatus, error)
			func github.com/yuin/goldmark/extension.(*FootnoteHTMLRenderer).renderFootnoteList(w BufWriter, source []byte, node gast.Node, entering bool) (gast.WalkStatus, error)
			func github.com/yuin/goldmark/extension.(*StrikethroughHTMLRenderer).renderStrikethrough(w BufWriter, source []byte, n gast.Node, entering bool) (gast.WalkStatus, error)
			func github.com/yuin/goldmark/extension.(*TableHTMLRenderer).renderTable(w BufWriter, source []byte, n gast.Node, entering bool) (gast.WalkStatus, error)
			func github.com/yuin/goldmark/extension.(*TableHTMLRenderer).renderTableCell(w BufWriter, source []byte, node gast.Node, entering bool) (gast.WalkStatus, error)
			func github.com/yuin/goldmark/extension.(*TableHTMLRenderer).renderTableHeader(w BufWriter, source []byte, n gast.Node, entering bool) (gast.WalkStatus, error)
			func github.com/yuin/goldmark/extension.(*TableHTMLRenderer).renderTableRow(w BufWriter, source []byte, n gast.Node, entering bool) (gast.WalkStatus, error)
			func github.com/yuin/goldmark/extension.(*TaskCheckBoxHTMLRenderer).renderTaskCheckBox(w BufWriter, source []byte, node gast.Node, entering bool) (gast.WalkStatus, error)
			func github.com/yuin/goldmark/renderer/html.escapeRune(writer BufWriter, r rune)
			func github.com/yuin/goldmark/renderer/html.(*Renderer).renderAutoLink(w BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error)
			func github.com/yuin/goldmark/renderer/html.(*Renderer).renderBlockquote(w BufWriter, source []byte, n ast.Node, entering bool) (ast.WalkStatus, error)
			func github.com/yuin/goldmark/renderer/html.(*Renderer).renderCodeBlock(w BufWriter, source []byte, n ast.Node, entering bool) (ast.WalkStatus, error)
			func github.com/yuin/goldmark/renderer/html.(*Renderer).renderCodeSpan(w BufWriter, source []byte, n ast.Node, entering bool) (ast.WalkStatus, error)
			func github.com/yuin/goldmark/renderer/html.(*Renderer).renderDocument(w BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error)
			func github.com/yuin/goldmark/renderer/html.(*Renderer).renderEmphasis(w BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error)
			func github.com/yuin/goldmark/renderer/html.(*Renderer).renderFencedCodeBlock(w BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error)
			func github.com/yuin/goldmark/renderer/html.(*Renderer).renderHeading(w BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error)
			func github.com/yuin/goldmark/renderer/html.(*Renderer).renderHTMLBlock(w BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error)
			func github.com/yuin/goldmark/renderer/html.(*Renderer).renderImage(w BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error)
			func github.com/yuin/goldmark/renderer/html.(*Renderer).renderLink(w BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error)
			func github.com/yuin/goldmark/renderer/html.(*Renderer).renderList(w BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error)
			func github.com/yuin/goldmark/renderer/html.(*Renderer).renderListItem(w BufWriter, source []byte, n ast.Node, entering bool) (ast.WalkStatus, error)
			func github.com/yuin/goldmark/renderer/html.(*Renderer).renderParagraph(w BufWriter, source []byte, n ast.Node, entering bool) (ast.WalkStatus, error)
			func github.com/yuin/goldmark/renderer/html.(*Renderer).renderRawHTML(w BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error)
			func github.com/yuin/goldmark/renderer/html.(*Renderer).renderString(w BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error)
			func github.com/yuin/goldmark/renderer/html.(*Renderer).renderText(w BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error)
			func github.com/yuin/goldmark/renderer/html.(*Renderer).renderTextBlock(w BufWriter, source []byte, n ast.Node, entering bool) (ast.WalkStatus, error)
			func github.com/yuin/goldmark/renderer/html.(*Renderer).renderThematicBreak(w BufWriter, source []byte, n ast.Node, entering bool) (ast.WalkStatus, error)
			func github.com/yuin/goldmark/renderer/html.(*Renderer).writeLines(w BufWriter, source []byte, n ast.Node)
			func golang.org/x/pkgsite/internal/postgres.(*HTMLRenderer).skipImage(w BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error)
			func golang.org/x/pkgsite/internal/postgres.(*HTMLRenderer).skipNode(w BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error)

	 type BytesFilter (interface)
		BytesFilter is a efficient data structure for checking whether bytes exist or not.
		BytesFilter is thread-safe.

		Methods (total 3, all are exported)
			( T) Add([]byte)
				Add adds given bytes to this set.

			( T) Contains([]byte) bool
				Contains return true if this set contains given bytes, otherwise false.

			( T) Extend(...[]byte) BytesFilter
				Extend copies this filter and adds given bytes to new filter.

		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*bytesFilter
		As Outputs Of (at least 2, both are exported)
			func NewBytesFilter(elements ...[]byte) BytesFilter
			func BytesFilter.Extend(...[]byte) BytesFilter
		As Inputs Of (at least one exported)
			func github.com/yuin/goldmark/renderer/html.RenderAttributes(w BufWriter, node ast.Node, filter BytesFilter)
		As Types Of (total 20, all are exported)
			  var github.com/yuin/goldmark/extension.DefinitionDescriptionAttributeFilter
			  var github.com/yuin/goldmark/extension.DefinitionListAttributeFilter
			  var github.com/yuin/goldmark/extension.DefinitionTermAttributeFilter
			  var github.com/yuin/goldmark/extension.StrikethroughAttributeFilter
			  var github.com/yuin/goldmark/extension.TableAttributeFilter
			  var github.com/yuin/goldmark/extension.TableHeaderAttributeFilter
			  var github.com/yuin/goldmark/extension.TableRowAttributeFilter
			  var github.com/yuin/goldmark/extension.TableTdCellAttributeFilter
			  var github.com/yuin/goldmark/extension.TableThCellAttributeFilter
			  var github.com/yuin/goldmark/renderer/html.BlockquoteAttributeFilter
			  var github.com/yuin/goldmark/renderer/html.CodeAttributeFilter
			  var github.com/yuin/goldmark/renderer/html.EmphasisAttributeFilter
			  var github.com/yuin/goldmark/renderer/html.GlobalAttributeFilter
			  var github.com/yuin/goldmark/renderer/html.HeadingAttributeFilter
			  var github.com/yuin/goldmark/renderer/html.ImageAttributeFilter
			  var github.com/yuin/goldmark/renderer/html.LinkAttributeFilter
			  var github.com/yuin/goldmark/renderer/html.ListAttributeFilter
			  var github.com/yuin/goldmark/renderer/html.ListItemAttributeFilter
			  var github.com/yuin/goldmark/renderer/html.ParagraphAttributeFilter
			  var github.com/yuin/goldmark/renderer/html.ThematicAttributeFilter

	 type CopyOnWriteBuffer (struct)
		A CopyOnWriteBuffer is a byte buffer that copies buffer when
		it need to be changed.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			buffer []byte
			copied bool
		Methods (total 8, all are exported)
			(*T) Append(value []byte)
				Append appends given bytes to the buffer.
				Append copy buffer at the first time.

			(*T) AppendByte(c byte)
				AppendByte appends given bytes to the buffer.
				AppendByte copy buffer at the first time.

			(*T) AppendString(value string)
				AppendString appends given string to the buffer.
				AppendString copy buffer at the first time.

			(*T) Bytes() []byte
				Bytes returns bytes of this buffer.

			(*T) IsCopied() bool
				IsCopied returns true if buffer has been copied, otherwise false.

			(*T) Write(value []byte)
				Write writes given bytes to the buffer.
				Write allocate new buffer and clears it at the first time.

			(*T) WriteByte(c byte)
				WriteByte writes the given byte to the buffer.
				WriteByte allocate new buffer and clears it at the first time.

			(*T) WriteString(value string)
				WriteString writes given string to the buffer.
				WriteString allocate new buffer and clears it at the first time.

		As Outputs Of (at least one exported)
			func NewCopyOnWriteBuffer(buffer []byte) CopyOnWriteBuffer

	 type HTML5Entity (struct)
		An HTML5Entity struct represents HTML5 entitites.

		Fields (total 3, all are exported)
			Characters []byte
			CodePoints []int
			Name string
		As Outputs Of (at least one exported)
			func LookUpHTML5EntityByName(name string) (*HTML5Entity, bool)

	 type PrioritizedSlice ([]T)
		PrioritizedSlice is a slice of the PrioritizedValues

		Methods (total 2, both are exported)
			( T) Remove(v interface{}) PrioritizedSlice
				Remove removes the given value from this slice.

			( T) Sort()
				Sort sorts the PrioritizedSlice in ascending order.

		As Outputs Of (at least one exported)
			func PrioritizedSlice.Remove(v interface{}) PrioritizedSlice

	 type PrioritizedValue (struct)
		A PrioritizedValue struct holds pair of an arbitrary value and a priority.

		Fields (total 2, both are exported)
			Priority int
				Priority is a priority of the value.

			Value interface{}
				Value is an arbitrary value that you want to prioritize.

		As Outputs Of (at least 4, all are exported)
			func Prioritized(v interface{}, priority int) PrioritizedValue
			func github.com/yuin/goldmark/parser.DefaultBlockParsers() []PrioritizedValue
			func github.com/yuin/goldmark/parser.DefaultInlineParsers() []PrioritizedValue
			func github.com/yuin/goldmark/parser.DefaultParagraphTransformers() []PrioritizedValue
		As Inputs Of (at least 5, all are exported)
			func github.com/yuin/goldmark/parser.WithASTTransformers(ps ...PrioritizedValue) parser.Option
			func github.com/yuin/goldmark/parser.WithBlockParsers(bs ...PrioritizedValue) parser.Option
			func github.com/yuin/goldmark/parser.WithInlineParsers(bs ...PrioritizedValue) parser.Option
			func github.com/yuin/goldmark/parser.WithParagraphTransformers(ps ...PrioritizedValue) parser.Option
			func github.com/yuin/goldmark/renderer.WithNodeRenderers(ps ...PrioritizedValue) renderer.Option

	/* one unexported ... *//* one unexported: */
	 type bytesFilter (struct)

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			chars [256]uint8
			slots [][][]byte
			threshold int
		Methods (total 3, all are exported)
			(*T) Add(b []byte)
			(*T) Contains(b []byte) bool
			(*T) Extend(bs ...[]byte) BytesFilter
		Implements (at least one exported)
			*T : BytesFilter


Package-Level Functions (total 48, in which 47 are exported)

	 func BytesToReadOnlyString(b []byte) string
		BytesToReadOnlyString returns a string converted from given bytes.

	 func DedentPosition(bs []byte, currentPos, width int) (pos, padding int)
		DedentPosition dedents lines by the given width.

	 func DedentPositionPadding(bs []byte, currentPos, paddingv, width int) (pos, padding int)
		DedentPositionPadding dedents lines by the given width.
		This function is mostly same as DedentPosition except this function
		takes account into additional paddings.

	 func DoFullUnicodeCaseFolding(v []byte) []byte
		DoFullUnicodeCaseFolding performs full unicode case folding to given bytes.

	 func EscapeHTML(v []byte) []byte
		EscapeHTML escapes characters that should be escaped in HTML text.

	 func EscapeHTMLByte(b byte) []byte
		EscapeHTMLByte returns HTML escaped bytes if the given byte should be escaped,
		otherwise nil.

	 func FindClosure(bs []byte, opener, closure byte, codeSpan, allowNesting bool) int
		FindClosure returns a position that closes the given opener.
		If codeSpan is set true, it ignores characters in code spans.
		If allowNesting is set true, closures correspond to nested opener will be
		ignored.

	 func FindEmailIndex(b []byte) int
		FindEmailIndex returns a stop index value if the given bytes seem an email address.

	 func FindURLIndex(b []byte) int
		FindURLIndex returns a stop index value if the given bytes seem an URL.
		This function is equivalent to [A-Za-z][A-Za-z0-9.+-]{1,31}:[^<>\x00-\x20]* .

	 func FirstNonSpacePosition(bs []byte) int
		FirstNonSpacePosition returns a position line that is a first nonspace
		character.

	 func IndentPosition(bs []byte, currentPos, width int) (pos, padding int)
		IndentPosition searches an indent position with the given width for the given line.
		If the line contains tab characters, paddings may be not zero.
		currentPos==0 and width==2:

		    position: 0    1
		              [TAB]aaaa
		    width:    1234 5678

		width=2 is in the tab character. In this case, IndentPosition returns
		(pos=1, padding=2)

	 func IndentPositionPadding(bs []byte, currentPos, paddingv, width int) (pos, padding int)
		IndentPositionPadding searches an indent position with the given width for the given line.
		This function is mostly same as IndentPosition except this function
		takes account into additional paddings.

	 func IndentWidth(bs []byte, currentPos int) (width, pos int)
		IndentWidth calculate an indent width for the given line.

	 func IsAlphaNumeric(c byte) bool
		IsAlphaNumeric returns true if the given character is a alphabet or a numeric, otherwise false.

	 func IsBlank(bs []byte) bool
		IsBlank returns true if the given string is all space characters.

	 func IsEscapedPunctuation(source []byte, i int) bool
		IsEscapedPunctuation returns true if character at a given index i
		is an escaped punctuation, otherwise false.

	 func IsHexDecimal(c byte) bool
		IsHexDecimal returns true if the given character is a hexdecimal, otherwise false.

	 func IsNumeric(c byte) bool
		IsNumeric returns true if the given character is a numeric, otherwise false.

	 func IsPunct(c byte) bool
		IsPunct returns true if the given character is a punctuation, otherwise false.

	 func IsPunctRune(r rune) bool
		IsPunctRune returns true if the given rune is a punctuation, otherwise false.

	 func IsSpace(c byte) bool
		IsSpace returns true if the given character is a space, otherwise false.

	 func IsSpaceRune(r rune) bool
		IsSpaceRune returns true if the given rune is a space, otherwise false.

	 func LookUpHTML5EntityByName(name string) (*HTML5Entity, bool)
		LookUpHTML5EntityByName returns (an HTML5Entity, true) if an entity named
		given name is found, otherwise (nil, false)

	 func NewBytesFilter(elements ...[]byte) BytesFilter
		NewBytesFilter returns a new BytesFilter.

	 func NewCopyOnWriteBuffer(buffer []byte) CopyOnWriteBuffer
		NewCopyOnWriteBuffer returns a new CopyOnWriteBuffer.

	 func Prioritized(v interface{}, priority int) PrioritizedValue
		Prioritized returns a new PrioritizedValue.

	 func ReadWhile(source []byte, index [2]int, pred func(byte) bool) (int, bool)
		ReadWhile read the given source while pred is true.

	 func ReplaceSpaces(source []byte, repl byte) []byte
		ReplaceSpaces replaces sequence of spaces with the given repl.

	 func ResolveEntityNames(source []byte) []byte
		ResolveEntityNames resolve entity references like '&ouml;" .

	 func ResolveNumericReferences(source []byte) []byte
		ResolveNumericReferences resolve numeric references like '&#1234;" .

	 func StringToReadOnlyBytes(s string) (bs []byte)
		StringToReadOnlyBytes returns bytes converted from given string.

	 func TabWidth(currentPos int) int
		TabWidth calculates actual width of a tab at the given position.

	 func ToLinkReference(v []byte) string
		ToLinkReference converts given bytes into a valid link reference string.
		ToLinkReference performs unicode case folding, trims leading and trailing spaces,  converts into lower
		case and replace spaces with a single space character.

	 func ToRune(source []byte, pos int) rune
		ToRune decode given bytes start at pos and returns a rune.

	 func ToValidRune(v rune) rune
		ToValidRune returns 0xFFFD if the given rune is invalid, otherwise v.

	 func TrimLeft(source, b []byte) []byte
		TrimLeft trims characters in the given s from head of the source.
		bytes.TrimLeft offers same functionalities, but bytes.TrimLeft
		allocates new buffer for the result.

	 func TrimLeftLength(source, s []byte) int
		TrimLeftLength returns a length of leading specified characters.

	 func TrimLeftSpace(source []byte) []byte
		TrimLeftSpace returns a subslice of the given string by slicing off all leading
		space characters.

	 func TrimLeftSpaceLength(source []byte) int
		TrimLeftSpaceLength returns a length of leading space characters.

	 func TrimRight(source, b []byte) []byte
		TrimRight trims characters in the given s from tail of the source.

	 func TrimRightLength(source, s []byte) int
		TrimRightLength returns a length of trailing specified characters.

	 func TrimRightSpace(source []byte) []byte
		TrimRightSpace returns a subslice of the given string by slicing off all trailing
		space characters.

	 func TrimRightSpaceLength(source []byte) int
		TrimRightSpaceLength returns a length of trailing space characters.

	 func UnescapePunctuations(source []byte) []byte
		UnescapePunctuations unescapes blackslash escaped punctuations.

	 func URLEscape(v []byte, resolveReference bool) []byte
		URLEscape escape the given URL.
		If resolveReference is set true:
		  1. unescape punctuations
		  2. resolve numeric references
		  3. resolve entity references

		URL encoded values (%xx) are kept as is.

	 func UTF8Len(b byte) int8
		UTF8Len returns a byte length of the utf-8 character.

	 func VisualizeSpaces(bs []byte) []byte
		VisualizeSpaces visualize invisible space characters.

	/* one unexported ... *//* one unexported: */
	 func bytesHash(b []byte) uint64
Package-Level Variables (total 12, none are exported)

	/* 12 unexporteds ... *//* 12 unexporteds: */
	  var emailDomainRegexp *regexp.Regexp
	  var emailTable [256]uint8
	  var html5entities map[string]*HTML5Entity
	  var htmlEscapeTable [256][]byte
	  var htmlSpace []byte
	  var punctTable [256]int8
	  var spaces []byte
	  var spaceTable [256]int8
	  var unicodeCaseFoldings map[rune][]rune
	  var urlEscapeTable [256]int8
		a-zA-Z0-9, ;/?:@&=+$,-_.!~*'()#

	  var urlTable [256]uint8
	  var utf8lenTable [256]int8

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.