payloads

Documentation

Index

• type Metadata
  • func NewMetadata() *Metadata
  • func ReadMetadata(payload warc.IPayload) (*Metadata, error)
  • func (metadata *Metadata) Bytes() ([]byte, error)
  • func (metadata *Metadata) Length() (uint64, error)
  • func (metadata *Metadata) Reader() (io.Reader, error)
  • func (metadata *Metadata) String() (string, error)
  • func (metadata *Metadata) Write(writer io.Writer) (int, error)

Types

type Metadata

type Metadata struct {
	Targets []string
}

Metadata is a Larch-specific record payload for metadata about the archival process.

func NewMetadata

func NewMetadata() *Metadata

NewMetadata creates a new Metadata payload.

func ReadMetadata

func ReadMetadata(payload warc.IPayload) (*Metadata, error)

ReadMetadata converts / reads a payload into a Metadata payload.

func (*Metadata) Bytes

func (metadata *Metadata) Bytes() ([]byte, error)

Bytes returns the byte representation of the payload.

func (*Metadata) Length

func (metadata *Metadata) Length() (uint64, error)

func (*Metadata) Reader

func (metadata *Metadata) Reader() (io.Reader, error)

Reader returns a reader for the data.

func (*Metadata) String

func (metadata *Metadata) String() (string, error)

String converts the payload into a string.

func (*Metadata) Write

func (metadata *Metadata) Write(writer io.Writer) (int, error)

Write writes the payload to a stream.