box_format

package
v0.0.0-...-ed7c31d Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 28, 2026 License: MIT Imports: 20 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var ErrNotABox = newPkgError("not a box")

Functions

This section is empty.

Types

type BoxCheckedOut

type BoxCheckedOut struct {
	BoxTransacted
	// contains filtered or unexported fields
}

func MakeBoxCheckedOut

func (*BoxCheckedOut) EncodeStringTo

func (format *BoxCheckedOut) EncodeStringTo(
	co *sku.CheckedOut,
	sw interfaces.WriterAndStringWriter,
) (n int64, err error)

type BoxTransacted

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

func MakeBoxTransacted

func MakeBoxTransacted(
	colorOptions string_format_writer.ColorOptions,
	options options_print.Options,
	boxStringEncoder interfaces.StringEncoderTo[string_format_writer.Box],
	abbr ids.Abbr,
	fsItemReadWriter sku.FSItemReadWriter,
	relativePath env_dir.RelativePath,
	headerWriter string_format_writer.HeaderWriter[*sku.Transacted],
) *BoxTransacted

func MakeBoxTransactedArchive

func MakeBoxTransactedArchive(
	env env_ui.Env,
	optionsOriginal options_print.Options,
) *BoxTransacted

func (*BoxTransacted) EncodeStringTo

func (format *BoxTransacted) EncodeStringTo(
	object *sku.Transacted,
	writer interfaces.WriterAndStringWriter,
) (n int64, err error)

func (*BoxTransacted) ReadStringFormat

func (format *BoxTransacted) ReadStringFormat(
	object *sku.Transacted,
	runeScanner io.RuneScanner,
) (n int64, err error)

TODO make this error for invalid input

type CheckedOutHeaderDeleted

type CheckedOutHeaderDeleted struct {
	domain_interfaces.ConfigDryRunGetter
}

func (CheckedOutHeaderDeleted) WriteBoxHeader

func (f CheckedOutHeaderDeleted) WriteBoxHeader(
	header *string_format_writer.BoxHeader,
	co *sku.CheckedOut,
) (err error)

type CheckedOutHeaderState

type CheckedOutHeaderState struct{}

func (CheckedOutHeaderState) WriteBoxHeader

func (f CheckedOutHeaderState) WriteBoxHeader(
	header *string_format_writer.BoxHeader,
	checkedOut *sku.CheckedOut,
) (err error)

type CheckedOutHeaderString

type CheckedOutHeaderString string

func (CheckedOutHeaderString) WriteBoxHeader

func (f CheckedOutHeaderString) WriteBoxHeader(
	header *string_format_writer.BoxHeader,
	co *sku.CheckedOut,
) (err error)

type ErrBoxParse

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

func (ErrBoxParse) Error

func (err ErrBoxParse) Error() string

func (ErrBoxParse) GetErrorType

func (err ErrBoxParse) GetErrorType() pkgErrDisamb

func (ErrBoxParse) Is

func (err ErrBoxParse) Is(target error) bool

func (ErrBoxParse) Unwrap

func (err ErrBoxParse) Unwrap() error

type ErrBoxReadSeq

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

func (ErrBoxReadSeq) Error

func (err ErrBoxReadSeq) Error() string

func (ErrBoxReadSeq) GetErrorType

func (err ErrBoxReadSeq) GetErrorType() pkgErrDisamb

func (ErrBoxReadSeq) Is

func (err ErrBoxReadSeq) Is(target error) bool

type ErrUnsupportedDodderTag

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

func (ErrUnsupportedDodderTag) Error

func (err ErrUnsupportedDodderTag) Error() string

func (ErrUnsupportedDodderTag) GetErrorType

func (err ErrUnsupportedDodderTag) GetErrorType() pkgErrDisamb

func (ErrUnsupportedDodderTag) Is

func (err ErrUnsupportedDodderTag) Is(target error) bool

type TransactedHeaderUserTai

type TransactedHeaderUserTai struct{}

func (TransactedHeaderUserTai) WriteBoxHeader

func (f TransactedHeaderUserTai) WriteBoxHeader(
	header *string_format_writer.BoxHeader,
	object *sku.Transacted,
) (err error)

Source Files

  • checked_out.go
  • checked_out_header_deleted.go
  • checked_out_header_state.go
  • checked_out_header_string.go
  • errors.go
  • read.go
  • transacted.go
  • transacted_header_user_tai.go

Jump to

Keyboard shortcuts

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