reader

package

v0.3.0 Latest Latest Go to latest Published: Dec 27, 2023 License: Apache-2.0 Imports: 8 Imported by: 0

Details

This section is empty.

This section is empty.

func GetFormatUnserializer(format formats.Format) (native.Unserializer, error)

func RegisterUnserializer(format formats.Format, u native.Unserializer)

RegisterUnserializer registers a new unserializer to parse a specific format. The new unserializer replaces any previously defined driver.

func UnregisterUnserializer(format formats.Format)

UnregisterUnserializer removes a serializer from the list of available

type Options struct {
	Format             formats.Format
	UnserializeOptions *native.UnserializeOptions
	// contains filtered or unexported fields
}

func (o *Options) GetFormatOptions(key interface{}) interface{}

func (o *Options) SetFormatOptions(key, opts interface{})

type Reader struct {
	Options *Options
	// contains filtered or unexported fields
}

func New(opts ...ReaderOption) *Reader

func (r *Reader) ParseFile(path string) (*sbom.Document, error)

ParseFile reads a file and returns an sbom.Document

func (r *Reader) ParseFileWithOptions(path string, o *Options) (*sbom.Document, error)

ParseFile reads a file and returns an sbom.Document

func (r *Reader) ParseStream(f io.ReadSeeker) (*sbom.Document, error)

ParseStreamWithOptions returns a document from a ioreader

func (r *Reader) ParseStreamWithOptions(f io.ReadSeeker, o *Options) (*sbom.Document, error)

ParseStreamWithOptions returns a document from a ioreader, accept options for unserializer

type ReaderOption func(*Reader)

func WithFormatOptions(driverKey string, opts interface{}) ReaderOption

func WithSniffer(s Sniffer) ReaderOption

func WithUnserializeOptions(uo *native.UnserializeOptions) ReaderOption

type Sniffer interface {
	SniffReader(rs io.ReadSeeker) (formats.Format, error)
	SniffFile(path string) (formats.Format, error)
}

Path	Synopsis
readerfakes Code generated by counterfeiter.	Code generated by counterfeiter.