kif

package module

v1.2.1 Latest Latest Go to latest Published: Dec 28, 2020 License: BSD-2-Clause-Views Imports: 13 Imported by: 6

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

Repository

github.com/yunomu/kif

Links

Open Source Insights

README ¶

kif

KIF parser and printer

https://pkg.go.dev/github.com/yunomu/kif

Reference

http://kakinoki.o.oo7.jp/kif_format.html

Documentation ¶

Index ¶

Variables
func Normalize(k *ptypes.Kif)
func PieceFromName(name string) ptypes.Piece_Id
func PrintElapsed(sec int32) string
func PrintFinishedStatus(s ptypes.FinishedStatus_Id) string
func PrintModifier(m ptypes.Modifier_Id) string
func PrintMove(s *ptypes.Step) string
func PrintPhase(s *ptypes.Step) string
func PrintPiece(p ptypes.Piece_Id) string
func PrintPos(p *ptypes.Pos) string
func PrintThinking(sec int32) string
func SetEndTime(k *ptypes.Kif, t time.Time)
func SetStartTime(k *ptypes.Kif, t time.Time)
func StepToMove(step *ptypes.Step) string
type Format
type ParseOption
- func ParseEncodingSJIS() ParseOption
- func ParseEncodingUTF8() ParseOption
type Parser
- func NewParser(ops ...ParseOption) *Parser
- func (p *Parser) Parse(in io.Reader) (*ptypes.Kif, error)
type Writer
- func NewWriter(ops ...WriterOption) *Writer
- func (w *Writer) Write(out io.Writer, kif *ptypes.Kif) error
type WriterOption
- func SetDelimiter(delimiter string) WriterOption
- func SetFormat(format Format) WriterOption
- func WriteEncodingSJIS() WriterOption
- func WriteEncodingUTF8() WriterOption

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	EOS         = fmt.Errorf("EOS")
	ErrMismatch = fmt.Errorf("mismatch")
)

Functions ¶

func Normalize ¶

func Normalize(k *ptypes.Kif)

func PieceFromName ¶

func PieceFromName(name string) ptypes.Piece_Id

func PrintElapsed ¶

func PrintElapsed(sec int32) string

func PrintFinishedStatus ¶

func PrintFinishedStatus(s ptypes.FinishedStatus_Id) string

func PrintModifier ¶

func PrintModifier(m ptypes.Modifier_Id) string

func PrintMove ¶

func PrintMove(s *ptypes.Step) string

func PrintPhase ¶

func PrintPhase(s *ptypes.Step) string

func PrintPiece ¶

func PrintPiece(p ptypes.Piece_Id) string

func PrintPos ¶

func PrintPos(p *ptypes.Pos) string

func PrintThinking ¶

func PrintThinking(sec int32) string

func SetEndTime ¶

func SetEndTime(k *ptypes.Kif, t time.Time)

func SetStartTime ¶

func SetStartTime(k *ptypes.Kif, t time.Time)

func StepToMove ¶

func StepToMove(step *ptypes.Step) string

Types ¶

type Format ¶

type Format int

const (
	Format_KIF Format = iota
	Format_SFEN
)

type ParseOption ¶

type ParseOption func(*Parser)

func ParseEncodingSJIS ¶

func ParseEncodingSJIS() ParseOption

func ParseEncodingUTF8 ¶

func ParseEncodingUTF8() ParseOption

type Parser ¶

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

func NewParser ¶

func NewParser(ops ...ParseOption) *Parser

func (*Parser) Parse ¶

func (p *Parser) Parse(in io.Reader) (*ptypes.Kif, error)

type Writer ¶

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

func NewWriter ¶

func NewWriter(ops ...WriterOption) *Writer

func (*Writer) Write ¶

func (w *Writer) Write(out io.Writer, kif *ptypes.Kif) error

type WriterOption ¶

type WriterOption func(*Writer)

func SetDelimiter ¶

func SetDelimiter(delimiter string) WriterOption

func SetFormat ¶

func SetFormat(format Format) WriterOption

func WriteEncodingSJIS ¶

func WriteEncodingSJIS() WriterOption

func WriteEncodingUTF8 ¶

func WriteEncodingUTF8() WriterOption

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
kif
ptypes

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL