payload

Documentation

Index

• Constants
• Variables
• type GenericDataPayload
  • func NewGenericDataPayload(data []byte) *GenericDataPayload
  • func (g *GenericDataPayload) Blob() []byte
  • func (g *GenericDataPayload) Type() Type
• type Payload
  • func FromBytes(data []byte) (payloadDecoded Payload, consumedBytes int, err error)
• type Type
  • func NewType(typeNumber uint32, typeName string) (payloadType Type)
  • func (t Type) Bytes() (bytes []byte)
  • func (t Type) String() string

Constants

const MaxSize = 64636

MaxPayloadSize = MaxMessageSize -

                   (version(1) + parentsBlocksCount(1) + 3 * (parentsType(1) + parentsCount(1) + 8 * reference(32)) +
		      issuerPK(32) + issuanceTime(8) + seqNum(8) + payloadLength(4) + nonce(8) + signature(64)
		      = MaxMessageSize - 1158 bytes = 64378

Variables

var GenericDataPayloadType = NewType(0, "GenericDataPayloadType")

GenericDataPayloadType is the Type of a generic GenericDataPayload.

Types

type GenericDataPayload

type GenericDataPayload struct {
	model.Immutable[GenericDataPayload, *GenericDataPayload, genericDataPayloadInner] `serix:"0"`
}

GenericDataPayload represents a payload which just contains a blob of data.

func NewGenericDataPayload

func NewGenericDataPayload(data []byte) *GenericDataPayload

NewGenericDataPayload creates new GenericDataPayload.

func (*GenericDataPayload) Blob

func (g *GenericDataPayload) Blob() []byte

Blob returns the contained data of the GenericDataPayload (without its type and size headers).

func (*GenericDataPayload) Type

func (g *GenericDataPayload) Type() Type

Type returns the Type of the Payload.

type Payload

type Payload interface {
	// Type returns the Type of the Payload.
	Type() Type

	// Bytes returns a marshaled version of the Payload.
	Bytes() ([]byte, error)

	// String returns a human readable version of the Payload.
	String() string
}

Payload represents the generic interface for an object that can be embedded in Messages of the Tangle.

func FromBytes

func FromBytes(data []byte) (payloadDecoded Payload, consumedBytes int, err error)

FromBytes unmarshals a Payload from a sequence of bytes.

type Type

type Type uint32

Type represents the Type of a payload.

func NewType

func NewType(typeNumber uint32, typeName string) (payloadType Type)

NewType creates and registers a new payload Type.

func (Type) Bytes

func (t Type) Bytes() (bytes []byte)

Bytes returns a marshaled version of the Type.

func (Type) String

func (t Type) String() string

String returns a human-readable version of the Type for debug purposes.