utils

type AlternateStringer interface {
	AlternateString() (v string, use bool)
}

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

type AsciiBoxWriter interface {
	BoxBox(box AsciiBox, options ...func(*BoxOptions)) AsciiBox
	BoxString(data string, options ...func(*BoxOptions)) AsciiBox
	AlignBoxes(asciiBoxes []AsciiBox, desiredWith int, options ...func(*BoxOptions)) AsciiBox
	BoxSideBySide(box1 AsciiBox, box2 AsciiBox, options ...func(*BoxOptions)) AsciiBox
	BoxBelowBox(box1 AsciiBox, box2 AsciiBox, options ...func(*BoxOptions)) AsciiBox
}

type AsciiBoxer interface {
	// Box with options
	Box(...func(*BoxOptions)) AsciiBox
}

type BoxOptions struct {
	// The name of the box
	Name string
	// The additional header of the box appearing on the right upper side
	Header string
	// The additional footer of the box appearing on the right lower side
	Footer string
	// The desired CharWidth
	CharWidth int
	// The BoxSet used to print this box
	BoxSet BoxSet
}

type BoxSet struct {
	UpperLeftCorner  string
	UpperRightCorner string
	HorizontalLine   string
	VerticalLine     string
	LowerLeftCorner  string
	LowerRightCorner string
}

type BufferCommons struct {
}

type ByteOrderAware interface {
	GetByteOrder() binary.ByteOrder
	SetByteOrder(byteOrder binary.ByteOrder)
}

type Copyable interface {
	DeepCopy() any
}

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

type ErrorIdentify interface {
	Is(target error) bool
}

type LengthAware interface {
	// GetLengthInBytes returns the length in bytes
	GetLengthInBytes(ctx context.Context) uint16
	// GetLengthInBits returns the length in bits
	GetLengthInBits(ctx context.Context) uint16
}

type ParseAssertError struct {
	Message string
	Err     error // TODO: make available as root cause
}

type ParseValidationError struct {
	Message string
}

type PositionAware interface {
	// GetPos return the current byte position
	GetPos() uint16
}

type ReadBuffer interface {
	PositionAware
	ByteOrderAware
	// Reset sets the position to the supplied byte position
	Reset(pos uint16)
	// HasMore returns true if there are bitLength bits available
	HasMore(bitLength uint8) bool
	// PullContext signals that we expect now a context with the supplied logical name
	PullContext(logicalName string, readerArgs ...WithReaderArgs) error
	ReadBit(logicalName string, readerArgs ...WithReaderArgs) (bool, error)
	ReadByte(logicalName string, readerArgs ...WithReaderArgs) (byte, error)
	ReadByteArray(logicalName string, numberOfBytes int, readerArgs ...WithReaderArgs) ([]byte, error)
	ReadUint8(logicalName string, bitLength uint8, readerArgs ...WithReaderArgs) (uint8, error)
	ReadUint16(logicalName string, bitLength uint8, readerArgs ...WithReaderArgs) (uint16, error)
	ReadUint32(logicalName string, bitLength uint8, readerArgs ...WithReaderArgs) (uint32, error)
	ReadUint64(logicalName string, bitLength uint8, readerArgs ...WithReaderArgs) (uint64, error)
	ReadInt8(logicalName string, bitLength uint8, readerArgs ...WithReaderArgs) (int8, error)
	ReadInt16(logicalName string, bitLength uint8, readerArgs ...WithReaderArgs) (int16, error)
	ReadInt32(logicalName string, bitLength uint8, readerArgs ...WithReaderArgs) (int32, error)
	ReadInt64(logicalName string, bitLength uint8, readerArgs ...WithReaderArgs) (int64, error)
	ReadBigInt(logicalName string, bitLength uint64, readerArgs ...WithReaderArgs) (*big.Int, error)
	ReadFloat32(logicalName string, bitLength uint8, readerArgs ...WithReaderArgs) (float32, error)
	ReadFloat64(logicalName string, bitLength uint8, readerArgs ...WithReaderArgs) (float64, error)
	ReadBigFloat(logicalName string, bitLength uint8, readerArgs ...WithReaderArgs) (*big.Float, error)
	ReadString(logicalName string, bitLength uint32, readerArgs ...WithReaderArgs) (string, error)
	// CloseContext signals that we expect the end of the context with the supplied logical name
	CloseContext(logicalName string, readerArgs ...WithReaderArgs) error
}

type ReadBufferByteBased interface {
	ReadBuffer
	GetBytes() []byte
	GetTotalBytes() uint64
	PeekByte(offset byte) byte
}

type ReadBufferByteBasedOptions = func(b *byteReadBuffer)

type Serializable interface {
	// Serialize serializes this type
	Serialize() ([]byte, error)
	// SerializeWithWriteBuffer serializes this type with a custom buffer
	SerializeWithWriteBuffer(ctx context.Context, writeBuffer WriteBuffer) error
}

type Stack struct {
	list.List
}

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

type WithReaderArgs interface {
	// contains filtered or unexported methods
}

type WithReaderWriterArgs interface {
	WithReaderArgs
	WithWriterArgs
}

type WithWriterArgs interface {
	// contains filtered or unexported methods
}

type WriteBuffer interface {
	PositionAware
	ByteOrderAware
	// PushContext signals opening context with the supplied logical name
	PushContext(logicalName string, writerArgs ...WithWriterArgs) error
	WriteBit(logicalName string, value bool, writerArgs ...WithWriterArgs) error
	WriteByte(logicalName string, value byte, writerArgs ...WithWriterArgs) error
	WriteByteArray(logicalName string, data []byte, writerArgs ...WithWriterArgs) error
	WriteUint8(logicalName string, bitLength uint8, value uint8, writerArgs ...WithWriterArgs) error
	WriteUint16(logicalName string, bitLength uint8, value uint16, writerArgs ...WithWriterArgs) error
	WriteUint32(logicalName string, bitLength uint8, value uint32, writerArgs ...WithWriterArgs) error
	WriteUint64(logicalName string, bitLength uint8, value uint64, writerArgs ...WithWriterArgs) error
	WriteInt8(logicalName string, bitLength uint8, value int8, writerArgs ...WithWriterArgs) error
	WriteInt16(logicalName string, bitLength uint8, value int16, writerArgs ...WithWriterArgs) error
	WriteInt32(logicalName string, bitLength uint8, value int32, writerArgs ...WithWriterArgs) error
	WriteInt64(logicalName string, bitLength uint8, value int64, writerArgs ...WithWriterArgs) error
	WriteBigInt(logicalName string, bitLength uint8, value *big.Int, writerArgs ...WithWriterArgs) error
	WriteFloat32(logicalName string, bitLength uint8, value float32, writerArgs ...WithWriterArgs) error
	WriteFloat64(logicalName string, bitLength uint8, value float64, writerArgs ...WithWriterArgs) error
	WriteBigFloat(logicalName string, bitLength uint8, value *big.Float, writerArgs ...WithWriterArgs) error
	WriteString(logicalName string, bitLength uint32, value string, writerArgs ...WithWriterArgs) error
	WriteVirtual(ctx context.Context, logicalName string, value any, writerArgs ...WithWriterArgs) error
	WriteSerializable(ctx context.Context, serializable Serializable) error
	// PopContext signals work done with the context with the supplied logical name
	PopContext(logicalName string, writerArgs ...WithWriterArgs) error
}

type WriteBufferBoxBased interface {
	WriteBuffer
	GetBox() AsciiBox
}

type WriteBufferByteBased interface {
	WriteBuffer
	GetPos() uint16
	GetBytes() []byte
	GetTotalBytes() uint64
}

type WriteBufferByteBasedOptions = func(b *byteWriteBuffer)

type WriteBufferJsonBased interface {
	WriteBuffer
	GetJsonString() (string, error)
}

type WriteBufferXmlBased interface {
	WriteBuffer
	GetXmlString() string
}