asciiscan

package

v0.0.0-...-16767da Latest Latest Go to latest Published: Jul 16, 2023 License: MIT Imports: 7 Imported by: 0

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 asciiscan is used to parse plaintext files into structured data

This section is empty.

This section is empty.

func ConsumeProperty(s string) (string, string)

It's common for properties to be specified as "foo : bar". Parse them out.

func IsProperty(s string) bool

Check to see if the line looks like a property (contains a colon character).

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

func New(filename string) (*Scanner, error)

func (s *Scanner) Bufio() *bufio.Scanner

func (s *Scanner) Close() error

func (s *Scanner) ConsumeBool() (bool, error)

func (s *Scanner) ConsumeBoolPtr(to *bool) error

func (s *Scanner) ConsumeBoolPtrs(ptrs ...*bool) error

func (s *Scanner) ConsumeInt() (int, error)

func (s *Scanner) ConsumeIntPtr(to *int) error

func (s *Scanner) ConsumeIntPtrs(ptrs ...*int) error

func (s *Scanner) ConsumeProperty() (string, string, error)

func (s *Scanner) ConsumeString() (string, error)

func (s *Scanner) ConsumeStringList(skip ...string) ([]string, error)

Reads a list of non-property lines, skipping any that match the given strings

func (s *Scanner) PeekProperty() (bool, error)

Checks if the next line might be a property, without reading it