writer

package

v1.0.0 Latest Latest Go to latest Published: Aug 27, 2020 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/sourcegraph/lsif-protocol

Links

Open Source Insights

Documentation ¶

Index ¶

type Emitter
- func NewEmitter(writer JSONWriter) *Emitter
type JSONWriter
- func NewJSONWriter(w io.Writer) JSONWriter

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Emitter ¶

type Emitter struct {
	// contains filtered or unexported fields
}

Emitter creates vertex and edge values and passes them to the underlying JSONWriter instance. Use of this struct guarantees that unique identifiers are generated for each constructed element.

func NewEmitter ¶

func NewEmitter(writer JSONWriter) *Emitter

func (*Emitter) EmitContains ¶

func (e *Emitter) EmitContains(outV uint64, inVs []uint64) uint64

func (*Emitter) EmitDefinitionResult ¶

func (e *Emitter) EmitDefinitionResult() uint64

func (*Emitter) EmitDocument ¶

func (e *Emitter) EmitDocument(languageID, path string) uint64

func (*Emitter) EmitHoverResult ¶

func (e *Emitter) EmitHoverResult(contents []protocol.MarkedString) uint64

func (*Emitter) EmitItem ¶

func (e *Emitter) EmitItem(outV uint64, inVs []uint64, docID uint64) uint64

func (*Emitter) EmitItemOfDefinitions ¶

func (e *Emitter) EmitItemOfDefinitions(outV uint64, inVs []uint64, docID uint64) uint64

func (*Emitter) EmitItemOfReferences ¶

func (e *Emitter) EmitItemOfReferences(outV uint64, inVs []uint64, docID uint64) uint64

func (*Emitter) EmitMetaData ¶

func (e *Emitter) EmitMetaData(root string, info protocol.ToolInfo) uint64

func (*Emitter) EmitMoniker ¶

func (e *Emitter) EmitMoniker(kind, scheme, identifier string) uint64

func (*Emitter) EmitMonikerEdge ¶

func (e *Emitter) EmitMonikerEdge(outV, inV uint64) uint64

func (*Emitter) EmitNext ¶

func (e *Emitter) EmitNext(outV, inV uint64) uint64

func (*Emitter) EmitPackageInformation ¶

func (e *Emitter) EmitPackageInformation(packageName, scheme, version string) uint64

func (*Emitter) EmitPackageInformationEdge ¶

func (e *Emitter) EmitPackageInformationEdge(outV, inV uint64) uint64

func (*Emitter) EmitProject ¶

func (e *Emitter) EmitProject(languageID string) uint64

func (*Emitter) EmitRange ¶

func (e *Emitter) EmitRange(start, end protocol.Pos) uint64

func (*Emitter) EmitReferenceResult ¶

func (e *Emitter) EmitReferenceResult() uint64

func (*Emitter) EmitResultSet ¶

func (e *Emitter) EmitResultSet() uint64

func (*Emitter) EmitTextDocumentDefinition ¶

func (e *Emitter) EmitTextDocumentDefinition(outV, inV uint64) uint64

func (*Emitter) EmitTextDocumentHover ¶

func (e *Emitter) EmitTextDocumentHover(outV, inV uint64) uint64

func (*Emitter) EmitTextDocumentReferences ¶

func (e *Emitter) EmitTextDocumentReferences(outV, inV uint64) uint64

func (*Emitter) Flush ¶

func (e *Emitter) Flush() error

func (*Emitter) NumElements ¶

func (e *Emitter) NumElements() uint64

type JSONWriter ¶

type JSONWriter interface {
	// Write emits a single vertex or edge value.
	Write(v interface{})

	// Flush ensures that all elements have been written to the underlying writer.
	Flush() error
}

JSONWriter serializes vertexes and edges into JSON and writes them to an underlying writer as newline-delimited JSON.

func NewJSONWriter ¶

func NewJSONWriter(w io.Writer) JSONWriter

NewJSONWriter creates a new JSONWriter wrapping the given writer.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL