envelope

Documentation

Overview

Package envelope defines the generic encapsulating format for torus objects.

Index

• type Envelope
• type Signed
  • func (e *Signed) GetID() *identity.ID
• type Unsigned
  • func (e *Unsigned) GetID() *identity.ID

Types

type Envelope

type Envelope interface {
	GetID() *identity.ID // avoid field collision
}

Envelope is the interface implemented by objects that encapsulate 'true' torus objects.

type Signed

type Signed struct {
	ID        *identity.ID        `json:"id"`
	Version   uint8               `json:"version"`
	Body      identity.Immutable  `json:"body"`
	Signature primitive.Signature `json:"sig"`
}

Signed is the generic format for encapsulating signed immutable request/response objects to/from torus.

func (*Signed) GetID

func (e *Signed) GetID() *identity.ID

GetID returns the ID of the object encapsulated in this envelope.

type Unsigned

type Unsigned struct {
	ID      *identity.ID     `json:"id"`
	Version uint8            `json:"version"`
	Body    identity.Mutable `json:"body"`
}

Unsigned is the generic format for encapsulating unsigned mutable request/response objects to/from torus.

func (*Unsigned) GetID

func (e *Unsigned) GetID() *identity.ID

GetID returns the ID of the object encapsulated in this envelope.