overlay

Documentation

Overview

Package overlay is a generated protocol buffer package.

It is generated from these files:

pwr/overlay/overlay.proto

It has these top-level messages:

OverlayHeader
OverlayOp

Index

• Constants
• Variables
• type OverlayHeader
  • func (*OverlayHeader) Descriptor() ([]byte, []int)
  • func (*OverlayHeader) ProtoMessage()
  • func (m *OverlayHeader) Reset()
  • func (m *OverlayHeader) String() string
• type OverlayOp
  • func (*OverlayOp) Descriptor() ([]byte, []int)
  • func (m *OverlayOp) GetData() []byte
  • func (m *OverlayOp) GetLen() int64
  • func (m *OverlayOp) GetType() OverlayOp_Type
  • func (*OverlayOp) ProtoMessage()
  • func (m *OverlayOp) Reset()
  • func (m *OverlayOp) String() string
• type OverlayOp_Type
  • func (OverlayOp_Type) EnumDescriptor() ([]byte, []int)
  • func (x OverlayOp_Type) String() string
• type OverlayPatchContext
  • func (ctx *OverlayPatchContext) Patch(r savior.Source, w io.WriteSeeker) error
• type OverlayWriter
  • func NewOverlayWriter(r io.Reader, readOffset int64, w io.Writer, overlayOffset int64) (OverlayWriter, error)

Constants

const OverlayMagic = 0xFEF6F00

Variables

var OverlayOp_Type_name = map[int32]string{
	0:    "SKIP",
	1:    "FRESH",
	2040: "HEY_YOU_DID_IT",
}

var OverlayOp_Type_value = map[string]int32{
	"SKIP":           0,
	"FRESH":          1,
	"HEY_YOU_DID_IT": 2040,
}

Types

type OverlayHeader

type OverlayHeader struct {
}

func (*OverlayHeader) Descriptor

func (*OverlayHeader) Descriptor() ([]byte, []int)

func (*OverlayHeader) ProtoMessage

func (*OverlayHeader) ProtoMessage()

func (*OverlayHeader) Reset

func (m *OverlayHeader) Reset()

func (*OverlayHeader) String

func (m *OverlayHeader) String() string

type OverlayOp

type OverlayOp struct {
	Type OverlayOp_Type `protobuf:"varint,1,opt,name=type,enum=io.itch.wharf.pwr.overlay.OverlayOp_Type" json:"type,omitempty"`
	Len  int64          `protobuf:"varint,2,opt,name=len" json:"len,omitempty"`
	Data []byte         `protobuf:"bytes,3,opt,name=data,proto3" json:"data,omitempty"`
}

func (*OverlayOp) Descriptor

func (*OverlayOp) Descriptor() ([]byte, []int)

func (*OverlayOp) GetData

func (m *OverlayOp) GetData() []byte

func (*OverlayOp) GetLen

func (m *OverlayOp) GetLen() int64

func (*OverlayOp) GetType

func (m *OverlayOp) GetType() OverlayOp_Type

func (*OverlayOp) ProtoMessage

func (*OverlayOp) ProtoMessage()

func (*OverlayOp) Reset

func (m *OverlayOp) Reset()

func (*OverlayOp) String

func (m *OverlayOp) String() string

type OverlayOp_Type

type OverlayOp_Type int32

const (
	OverlayOp_SKIP           OverlayOp_Type = 0
	OverlayOp_FRESH          OverlayOp_Type = 1
	OverlayOp_HEY_YOU_DID_IT OverlayOp_Type = 2040
)

func (OverlayOp_Type) EnumDescriptor

func (OverlayOp_Type) EnumDescriptor() ([]byte, []int)

func (OverlayOp_Type) String

func (x OverlayOp_Type) String() string

type OverlayPatchContext

type OverlayPatchContext struct{}

func (*OverlayPatchContext) Patch

func (ctx *OverlayPatchContext) Patch(r savior.Source, w io.WriteSeeker) error

type OverlayWriter

type OverlayWriter interface {
	io.Writer
	Finalize() error
	Flush() error

	ReadOffset() int64
	OverlayOffset() int64
}

func NewOverlayWriter

func NewOverlayWriter(r io.Reader, readOffset int64, w io.Writer, overlayOffset int64) (OverlayWriter, error)

NewOverlayWriter returns a writer that reads from `r` and only encodes changed data to `w`. Closing it will not close the underlying writer!