metadata

Documentation

Index

• Constants
• type Failure
  • func NewFailure(errorMessage string) *Failure
  • func (*Failure) Kind() string
• type Success
  • func NewSuccess(cid string) *Success
  • func (*Success) Kind() string

Constants

const FailureResult = annotator.FailureKind

const Kind = "ipfs"

const SuccessResult = annotator.SuccessKind

Types

type Failure

type Failure struct {
	Result       string `json:"result"`
	ErrorMessage string `json:"errorMessage"`
}

Failure defines the structure that encapsulates this publisher's result.

func NewFailure

func NewFailure(errorMessage string) *Failure

NewFailure is a factory function that returns an initialized Failure.

func (*Failure) Kind

func (*Failure) Kind() string

Kind returns the type of concrete implementation.

type Success

type Success struct {
	Result string `json:"result"`
	CID    string `json:"cid"`
}

Success defines the structure that encapsulates this publisher's result.

func NewSuccess

func NewSuccess(cid string) *Success

NewSuccess is a factory function that returns an initialized Success.

func (*Success) Kind

func (*Success) Kind() string

Kind returns the type of concrete implementation.