json

Documentation

Index

• func Read(content io.Reader) (*spdx.Document, error)
• func ReadInto(content io.Reader, doc common.AnyDocument) error
• func Write(doc common.AnyDocument, w io.Writer, opts ...WriteOption) error
• type WriteOption
  • func EscapeHTML(escape bool) WriteOption
  • func Indent(indent string) WriteOption

Functions

func Read

func Read(content io.Reader) (*spdx.Document, error)

Read takes an io.Reader and returns a fully-parsed current model SPDX Document or an error if any error is encountered.

func ReadInto

func ReadInto(content io.Reader, doc common.AnyDocument) error

ReadInto takes an io.Reader, reads in the SPDX document at the version provided and converts to the doc version

func Write

func Write(doc common.AnyDocument, w io.Writer, opts ...WriteOption) error

Write takes an SPDX Document and an io.Writer, and writes the document to the writer in JSON format.

Types

type WriteOption

type WriteOption func(*json.Encoder)

func EscapeHTML

func EscapeHTML(escape bool) WriteOption

func Indent

func Indent(indent string) WriteOption