directory

Documentation

Index

• type Options
  • func (opt Options) New(c context.Context) output.Output

Types

type Options

type Options struct {
	// Path is the output base path.
	//
	// All opened streams will be written to disk relative to this directory.
	//
	// All stream metadata will be written to 'path/of/stream/.meta.name' as JSON.
	//
	// Datagram streams will be written as 'path/of/stream/.N.name' where N is the
	// index of the datagram in the stream (i.e. 0 is the first datagram, etc.)
	Path string
}

Options should be used to configure and make a directory Output (using the .New() method).

func (Options) New

func (opt Options) New(c context.Context) output.Output

New creates a new file Output from the specified Options.