package text

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

Dependency Relation
	imports 5 packages, and imported by 5 packages

Involved Source Files

	  d package.go
		Package text provides functionalities to manipulate texts.

	    reader.go
	    segment.go
Package-Level Type Names (total 5)

	/* sort by: alphabet | popularity */
	 type BlockReader (interface)
		A BlockReader interface is a reader that is optimized for Blocks.

		Methods (total 20)
			( BlockReader) Advance(int)
				Advance advances the internal pointer.

			( BlockReader) AdvanceAndSetPadding(int, int)
				AdvanceAndSetPadding advances the internal pointer and add padding to the
				reader.

			( BlockReader) AdvanceLine()
				AdvanceLine advances the internal pointer to the next line head.

			( BlockReader) FindClosure(opener, closer byte, options FindClosureOptions) (*Segments, bool)
				FindClosure finds corresponding closure.

			( BlockReader) FindSubMatch(reg *regexp.Regexp) [][]byte
				Match performs regular expression searching to current line.

			( BlockReader) LineOffset() int
				LineOffset returns a distance from the line head to current position.

			( BlockReader) Match(reg *regexp.Regexp) bool
				Match performs regular expression matching to current line.

			( BlockReader) Peek() byte
				Peek returns a byte at current position without advancing the internal pointer.

			( BlockReader) PeekLine() ([]byte, Segment)
				PeekLine returns the current line without advancing the internal pointer.

			( BlockReader) Position() (int, Segment)
				Position returns current line number and position.

			( BlockReader) PrecendingCharacter() rune
				PrecendingCharacter returns a character just before current internal pointer.

			( BlockReader) ReadRune() (r rune, size int, err error)
			( BlockReader) Reset(segment *Segments)
				Reset resets current state and sets new segments to the reader.

			( BlockReader) ResetPosition()
				ResetPosition resets positions.

			( BlockReader) SetPadding(int)
				SetPadding sets padding to the reader.

			( BlockReader) SetPosition(int, Segment)
				SetPosition sets current line number and position.

			( BlockReader) SkipBlankLines() (Segment, int, bool)
				SkipSpaces skips blank lines and returns a non-blank line.
				If it reaches EOF, returns false.

			( BlockReader) SkipSpaces() (Segment, int, bool)
				SkipSpaces skips space characters and returns a non-blank line.
				If it reaches EOF, returns false.

			( BlockReader) Source() []byte
				Source returns a source of the reader.

			( BlockReader) Value(Segment) []byte
				Value returns a value of the given segment.

		Implements (at least 2)
			 BlockReader : Reader
			 BlockReader : io.RuneReader
		As Outputs Of (at least one exported)
			func NewBlockReader(source []byte, segments *Segments) BlockReader

	 type FindClosureOptions (struct)
		FindClosureOptions is options for Reader.FindClosure.

		Fields (total 4)
			Advance bool
				Advance is a flag for the FindClosure. If this is set to true,
				FindClosure advances pointers when closer is found.

			CodeSpan bool
				CodeSpan is a flag for the FindClosure. If this is set to true,
				FindClosure ignores closers in codespans.

			Nesting bool
				Nesting is a flag for the FindClosure. If this is set to true,
				FindClosure allows nesting.

			Newline bool
				Newline is a flag for the FindClosure. If this is set to true,
				FindClosure searches for a closer over multiple lines.

		As Inputs Of (at least 2)
			func BlockReader.FindClosure(opener, closer byte, options FindClosureOptions) (*Segments, bool)
			func Reader.FindClosure(opener, closer byte, options FindClosureOptions) (*Segments, bool)

	 type Reader (interface)
		A Reader interface provides abstracted method for reading text.

		Methods (total 19)
			( Reader) Advance(int)
				Advance advances the internal pointer.

			( Reader) AdvanceAndSetPadding(int, int)
				AdvanceAndSetPadding advances the internal pointer and add padding to the
				reader.

			( Reader) AdvanceLine()
				AdvanceLine advances the internal pointer to the next line head.

			( Reader) FindClosure(opener, closer byte, options FindClosureOptions) (*Segments, bool)
				FindClosure finds corresponding closure.

			( Reader) FindSubMatch(reg *regexp.Regexp) [][]byte
				Match performs regular expression searching to current line.

			( Reader) LineOffset() int
				LineOffset returns a distance from the line head to current position.

			( Reader) Match(reg *regexp.Regexp) bool
				Match performs regular expression matching to current line.

			( Reader) Peek() byte
				Peek returns a byte at current position without advancing the internal pointer.

			( Reader) PeekLine() ([]byte, Segment)
				PeekLine returns the current line without advancing the internal pointer.

			( Reader) Position() (int, Segment)
				Position returns current line number and position.

			( Reader) PrecendingCharacter() rune
				PrecendingCharacter returns a character just before current internal pointer.

			( Reader) ReadRune() (r rune, size int, err error)
			( Reader) ResetPosition()
				ResetPosition resets positions.

			( Reader) SetPadding(int)
				SetPadding sets padding to the reader.

			( Reader) SetPosition(int, Segment)
				SetPosition sets current line number and position.

			( Reader) SkipBlankLines() (Segment, int, bool)
				SkipSpaces skips blank lines and returns a non-blank line.
				If it reaches EOF, returns false.

			( Reader) SkipSpaces() (Segment, int, bool)
				SkipSpaces skips space characters and returns a non-blank line.
				If it reaches EOF, returns false.

			( Reader) Source() []byte
				Source returns a source of the reader.

			( Reader) Value(Segment) []byte
				Value returns a value of the given segment.

		Implemented By (at least one exported)
			 BlockReader (interface)
		Implements (at least one exported)
			 Reader : io.RuneReader
		As Outputs Of (at least one exported)
			func NewReader(source []byte) Reader
		As Inputs Of (at least 9)
			func github.com/yuin/goldmark/parser.ParseAttributes(reader Reader) (parser.Attributes, bool)
			func github.com/yuin/goldmark/parser.ASTTransformer.Transform(node *ast.Document, reader Reader, pc parser.Context)
			func github.com/yuin/goldmark/parser.BlockParser.Close(node ast.Node, reader Reader, pc parser.Context)
			func github.com/yuin/goldmark/parser.BlockParser.Continue(node ast.Node, reader Reader, pc parser.Context) parser.State
			func github.com/yuin/goldmark/parser.BlockParser.Open(parent ast.Node, reader Reader, pc parser.Context) (ast.Node, parser.State)
			func github.com/yuin/goldmark/parser.CloseBlocker.CloseBlock(parent ast.Node, block Reader, pc parser.Context)
			func github.com/yuin/goldmark/parser.InlineParser.Parse(parent ast.Node, block Reader, pc parser.Context) ast.Node
			func github.com/yuin/goldmark/parser.ParagraphTransformer.Transform(node *ast.Paragraph, reader Reader, pc parser.Context)
			func github.com/yuin/goldmark/parser.Parser.Parse(reader Reader, opts ...parser.ParseOption) ast.Node

	 type Segment (struct)
		A Segment struct holds information about source positions.

		Fields (total 3)
			Padding int
				Padding is a padding length of the segment.

			Start int
				Start is a start position of the segment.

			Stop int
				Stop is a stop position of the segment.
				This value should be excluded.

		Methods (total 10)
			(*Segment) Between(other Segment) Segment
				Between returns a segment between this segment and the given segment.

			(*Segment) ConcatPadding(v []byte) []byte
				ConcatPadding concats the padding to the given slice.

			(*Segment) IsEmpty() bool
				IsEmpty returns true if this segment is empty, otherwise false.

			(*Segment) Len() int
				Len returns a length of the segment.

			(*Segment) TrimLeftSpace(buffer []byte) Segment
				TrimLeftSpace returns a new segment by slicing off all leading
				space characters including padding.

			(*Segment) TrimLeftSpaceWidth(width int, buffer []byte) Segment
				TrimLeftSpaceWidth returns a new segment by slicing off leading space
				characters until the given width.

			(*Segment) TrimRightSpace(buffer []byte) Segment
				TrimRightSpace returns a new segment by slicing off all trailing
				space characters.

			(*Segment) Value(buffer []byte) []byte
				Value returns a value of the segment.

			(*Segment) WithStart(v int) Segment
				WithStart returns a new Segment with same value except Start.

			(*Segment) WithStop(v int) Segment
				WithStop returns a new Segment with same value except Stop.

		As Outputs Of (at least 18)
			func NewSegment(start, stop int) Segment
			func NewSegmentPadding(start, stop, n int) Segment
			func BlockReader.PeekLine() ([]byte, Segment)
			func BlockReader.Position() (int, Segment)
			func BlockReader.SkipBlankLines() (Segment, int, bool)
			func BlockReader.SkipSpaces() (Segment, int, bool)
			func Reader.PeekLine() ([]byte, Segment)
			func Reader.Position() (int, Segment)
			func Reader.SkipBlankLines() (Segment, int, bool)
			func Reader.SkipSpaces() (Segment, int, bool)
			func (*Segment).Between(other Segment) Segment
			func (*Segment).TrimLeftSpace(buffer []byte) Segment
			func (*Segment).TrimLeftSpaceWidth(width int, buffer []byte) Segment
			func (*Segment).TrimRightSpace(buffer []byte) Segment
			func (*Segment).WithStart(v int) Segment
			func (*Segment).WithStop(v int) Segment
			func (*Segments).At(i int) Segment
			func (*Segments).Sliced(lo, hi int) []Segment
		As Inputs Of (at least 13)
			func BlockReader.SetPosition(int, Segment)
			func BlockReader.Value(Segment) []byte
			func Reader.SetPosition(int, Segment)
			func Reader.Value(Segment) []byte
			func (*Segment).Between(other Segment) Segment
			func (*Segments).Append(t Segment)
			func (*Segments).AppendAll(t []Segment)
			func (*Segments).Set(i int, v Segment)
			func (*Segments).Unshift(v Segment)
			func github.com/yuin/goldmark/ast.MergeOrAppendTextSegment(parent ast.Node, s Segment)
			func github.com/yuin/goldmark/ast.MergeOrReplaceTextSegment(parent ast.Node, n ast.Node, s Segment)
			func github.com/yuin/goldmark/ast.NewRawTextSegment(v Segment) *ast.Text
			func github.com/yuin/goldmark/ast.NewTextSegment(v Segment) *ast.Text

	 type Segments (struct)
		Segments is a collection of the Segment.

		Methods (total 9)
			(*Segments) Append(t Segment)
				Append appends the given segment after the tail of the collection.

			(*Segments) AppendAll(t []Segment)
				AppendAll appends all elements of given segments after the tail of the collection.

			(*Segments) At(i int) Segment
				At returns a segment at the given index.

			(*Segments) Clear()
				Clear delete all element of the collection.

			(*Segments) Len() int
				Len returns the length of the collection.

			(*Segments) Set(i int, v Segment)
				Set sets the given Segment.

			(*Segments) SetSliced(lo, hi int)
				SetSliced replace the collection with a subsliced value.

			(*Segments) Sliced(lo, hi int) []Segment
				Sliced returns a subslice of the collection.

			(*Segments) Unshift(v Segment)
				Unshift insert the given Segment to head of the collection.

		As Outputs Of (at least 6)
			func NewSegments() *Segments
			func BlockReader.FindClosure(opener, closer byte, options FindClosureOptions) (*Segments, bool)
			func Reader.FindClosure(opener, closer byte, options FindClosureOptions) (*Segments, bool)
			func github.com/yuin/goldmark/ast.(*BaseBlock).Lines() *Segments
			func github.com/yuin/goldmark/ast.(*BaseInline).Lines() *Segments
			func github.com/yuin/goldmark/ast.Node.Lines() *Segments
		As Inputs Of (at least 5)
			func NewBlockReader(source []byte, segments *Segments) BlockReader
			func BlockReader.Reset(segment *Segments)
			func github.com/yuin/goldmark/ast.(*BaseBlock).SetLines(v *Segments)
			func github.com/yuin/goldmark/ast.(*BaseInline).SetLines(v *Segments)
			func github.com/yuin/goldmark/ast.Node.SetLines(*Segments)


Package-Level Functions (total 5)

	 func NewBlockReader(source []byte, segments *Segments) BlockReader
		NewBlockReader returns a new BlockReader.

	 func NewReader(source []byte) Reader
		NewReader return a new Reader that can read UTF-8 bytes .

	 func NewSegment(start, stop int) Segment
		NewSegment return a new Segment.

	 func NewSegmentPadding(start, stop, n int) Segment
		NewSegmentPadding returns a new Segment with the given padding.

	 func NewSegments() *Segments
		NewSegments return a new Segments.


Package-Level Constants (only one)

	const EOF byte = 255
		EOF indicates the end of file.

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.