codebuffer

package

v1.6.0 Latest Latest Go to latest Published: Aug 5, 2021 License: MIT Imports: 9 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package codebuffer is a package that provides a method to read trough a reader and separate the contents into code and text parts.

This section is empty.

This section is empty.

This section is empty.

type CodeBuffer struct {
	// contains filtered or unexported fields
}

CodeBuffer is a construct to walk over a text separating code from text blocks.

func New(r io.Reader, startTokens, endTokens []rune) *CodeBuffer

New creates a new CodeBuffer with the specified reader.

func (c *CodeBuffer) Iterator() (Iterator, error)

Iterator returns an iterator that can be used to walk trough the CodeBuffer.

type InReadingState struct{}

InReadingState is a error that will be returned when the CodeBuffer is busy on another thread.

func (InReadingState) Error() string

Error returns the error text for InReadingState.

type Iterator interface {
	Next() bool
	Value() *Part
	Error() error
}

Iterator represents an iterator that can be used to walk trough the CodeBuffer.

type Part struct {
	Type    PartType
	Content []byte
}

Part represents one part of the text.

type PartType uint8

PartType represents a part type.

const (
	// TextPartType represents a text part.
	TextPartType PartType = iota
	// CodePartType represents a code part.
	CodePartType
)