out

Documentation

Overview

Copyright © 2020 Ben Shi

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• type Format
• type SmexWriter
  • func NewMultiWriter(fs afero.Fs, w io.Writer, outFormat string) *SmexWriter
  • func NewWriter(fs afero.Fs, w io.Writer) *SmexWriter
  • func (w SmexWriter) Write(urls []xml.URL, loc bool) error

Types

type Format

type Format string

const (
	Stdout Format = "stdout"
	Csv    Format = "csv"
	Json   Format = "json"
)

type SmexWriter

type SmexWriter struct {
	Format Format
	// contains filtered or unexported fields
}

A SmexWriter writes records to different formats.

Returns a particular writer based on the type

func NewMultiWriter

func NewMultiWriter(fs afero.Fs, w io.Writer, outFormat string) *SmexWriter

NewMultiWriter returns a new SmexWriter that can be configured to write to multiple destinations.

func NewWriter

func NewWriter(fs afero.Fs, w io.Writer) *SmexWriter

NewWriter returns a new SmexWriter that writes to stdout

func (SmexWriter) Write

func (w SmexWriter) Write(urls []xml.URL, loc bool) error

write a slice of URL