publisher

Documentation

Overview

Package publisher provides interfaces for (re)publishing documents that are emitted by an `Iterator` instance.

Index

• type FeaturePublisher
  • func (pub *FeaturePublisher) Publish(ctx context.Context, emitter_uri string, uris ...string) (int64, error)
• type Publisher

Types

type FeaturePublisher

type FeaturePublisher struct {
	Publisher
	// AsJSON is a boolean flag signaling that the final output should be published as a JSON array.
	AsJSON bool
	// AsGeoJSON is a boolean flag signaling that the final output should be published as a GeoJSON FeatureCollection.
	AsGeoJSON bool
	// Writer is the underlying `io.Writer` instance where published data will be written to.
	Writer io.Writer
}

FeaturePublisher implements the Publisher interface for (re)publishing GeoJSON Feature documents that are emitted by an `Iterator` instance.

func (*FeaturePublisher) Publish

func (pub *FeaturePublisher) Publish(ctx context.Context, emitter_uri string, uris ...string) (int64, error)

Publish() will (re)publish all the documents emitted from an `Iterator` instance derived from 'emitter_uri' and 'uris'.

type Publisher

type Publisher interface {
	// Publish() publishes documents that are emitted by an `Iterator` instance. It takes as its arguments
	// a valid `emitter.Emitter` URI and a list of URIs to iterate through. It is assumed that implementations
	// of the Publisher interface will provide their own internal `emitter.EmitterCallbackFunc` callback
	// functions.
	Publish(context.Context, string, ...string) (int64, error)
}

type Publisher provides an interface for (re)publishing documents that are emitted by an `Iterator` instance.