head

Documentation

Index

• type Head
  • func New() *Head
  • func (h *Head) Check() error
  • func (h *Head) GetDomain() string
  • func (h *Head) GetId() string
  • func (h *Head) GetSequence() int
  • func (h *Head) SetDomain(val string)
  • func (h *Head) SetId(val string)
  • func (h *Head) SetSequence(val int)
  • func (h *Head) String() string
• type HeaderInterface

Types

type Head

type Head struct {
	Domain   string
	Id       string
	Sequence int
	BodyType string
	*stamp.Timestamp
	*signature.Signature
}

Head implements the record.HeaderInterface

func New

func New() *Head

New will create a new header and fill in the basic information

func (*Head) Check

func (h *Head) Check() error

Check to see if the package has the required information

func (*Head) GetDomain

func (h *Head) GetDomain() string

func (*Head) GetId

func (h *Head) GetId() string

func (*Head) GetSequence

func (h *Head) GetSequence() int

func (*Head) SetDomain

func (h *Head) SetDomain(val string)

func (*Head) SetId

func (h *Head) SetId(val string)

func (*Head) SetSequence

func (h *Head) SetSequence(val int)

func (*Head) String

func (h *Head) String() string

Convert the Head value to a string

type HeaderInterface

type HeaderInterface interface {
	IsTimeSet() bool
	GetSignature() ([]byte, error)
	SetSignature([]byte)
	Check() error
	IsSignatureSet() bool

	GetDomain() string
	SetDomain(string)
	GetId() string
	SetId(string)
	GetSequence() int
	SetSequence(int)
}

HeaderInterface defines the minimum set of calls required for a header