jsonl

func ReadInto ¶

func ReadInto(r io.Reader, cfg adjlist.Config) (*adjlist.AdjList[string, int64], int, error)

ReadInto consumes a JSON Lines stream from r and builds an adjacency list. Node records pre-intern endpoints; edge records add the edge with optional weight.

func ReadIntoCappedCtx ¶ added in v0.2.0

func ReadIntoCappedCtx(ctx context.Context, r io.Reader, cfg adjlist.Config, maxBytes int64) (*adjlist.AdjList[string, int64], int, error)

ReadIntoCappedCtx is ReadIntoCtx with an explicit input-size ceiling. When maxBytes > 0 the reader fails with ErrInputTooLarge the moment consumption exceeds the limit, before the offending line is fully buffered; a value of zero or less disables the cap.

func ReadIntoCtx ¶

func ReadIntoCtx(ctx context.Context, r io.Reader, cfg adjlist.Config) (*adjlist.AdjList[string, int64], int, error)

ReadIntoCtx is the context-aware variant of ReadInto. ctx.Err() is checked every 4096 rows. The input is capped at DefaultMaxBytes; use ReadIntoCappedCtx for an explicit ceiling.

On any error — a parse error, context cancellation, or the ErrInputTooLarge cap — the returned graph is nil; the import is all-or-nothing at the in-memory level, so a caller cannot accidentally commit a half-built graph. The typed error is returned unchanged; only the graph value is discarded.

func ReadWithProps ¶

func ReadWithProps(r io.Reader, cfg adjlist.Config) (*lpg.Graph[string, int64], int, error)

ReadWithProps consumes a JSON Lines stream from r and builds a labelled property graph. It handles "node", "edge", and "property" record types. Property records must appear after the "node" record for the referenced ID.

func ReadWithPropsCappedCtx ¶ added in v0.2.0

func ReadWithPropsCappedCtx(ctx context.Context, r io.Reader, cfg adjlist.Config, maxBytes int64) (*lpg.Graph[string, int64], int, error)

ReadWithPropsCappedCtx is ReadWithPropsCtx with an explicit input-size ceiling. When maxBytes > 0 the reader fails with ErrInputTooLarge the moment consumption exceeds the limit, before the offending line is fully buffered; a value of zero or less disables the cap.

func ReadWithPropsCtx ¶

func ReadWithPropsCtx(ctx context.Context, r io.Reader, cfg adjlist.Config) (*lpg.Graph[string, int64], int, error)

ReadWithPropsCtx is the context-aware variant of ReadWithProps. ctx.Err() is checked every 4096 rows. The input is capped at DefaultMaxBytes; use ReadWithPropsCappedCtx for an explicit ceiling.

On any error — a parse error, context cancellation, or the ErrInputTooLarge cap — the returned graph is nil; the import is all-or-nothing at the in-memory level, so a caller cannot accidentally commit a half-built graph. The typed error is returned unchanged; only the graph value is discarded.

func Write ¶

func Write(w io.Writer, a *adjlist.AdjList[string, int64]) (int, error)

Write streams every node and edge of a to w as JSON Lines. Nodes come first, then edges, so that on-read every endpoint is known before its referencing edge.

package main

import (
	"bytes"
	"fmt"

	"github.com/FlavioCFOliveira/GoGraph/graph/adjlist"
	"github.com/FlavioCFOliveira/GoGraph/graph/io/jsonl"
)

func main() {
	cfg := adjlist.Config{Directed: true}

	src := adjlist.New[string, int64](cfg)
	_ = src.AddEdge("a", "b", 7)
	_ = src.AddEdge("b", "c", 9)

	var buf bytes.Buffer
	if _, err := jsonl.Write(&buf, src); err != nil {
		panic(err)
	}

	dst, records, err := jsonl.ReadInto(&buf, cfg)
	if err != nil {
		panic(err)
	}

	fmt.Println("records read:", records)
	fmt.Println("order:", dst.Order())
	fmt.Println("size:", dst.Size())
	fmt.Println("b->c:", dst.HasEdge("b", "c"))
}

Output:
records read: 5
order: 3
size: 2
b->c: true

func WriteCtx ¶

func WriteCtx(ctx context.Context, w io.Writer, a *adjlist.AdjList[string, int64]) (int, error)

WriteCtx is the context-aware variant of Write. ctx.Err() is checked every 4096 records; on cancellation flushes the buffer and returns (recordsWritten, wrapped ctx.Err()).

func WriteWithProps ¶

func WriteWithProps(w io.Writer, g *lpg.Graph[string, int64]) (int, error)

WriteWithProps streams the full contents of an lpg.Graph to w as JSON Lines. Output order is: all node records, then all edge records, then all property records. This ordering ensures that ReadWithProps can reconstruct the graph in a single pass.

package main

import (
	"bytes"
	"fmt"

	"github.com/FlavioCFOliveira/GoGraph/graph/adjlist"
	"github.com/FlavioCFOliveira/GoGraph/graph/io/jsonl"
	"github.com/FlavioCFOliveira/GoGraph/graph/lpg"
)

func main() {
	cfg := adjlist.Config{Directed: true}

	src := lpg.New[string, int64](cfg)
	_ = src.AddEdge("alice", "bob", 1)
	_ = src.SetNodeProperty("alice", "city", lpg.StringValue("Lisbon"))

	var buf bytes.Buffer
	if _, err := jsonl.WriteWithProps(&buf, src); err != nil {
		panic(err)
	}

	dst, _, err := jsonl.ReadWithProps(&buf, cfg)
	if err != nil {
		panic(err)
	}

	got, ok := dst.GetNodeProperty("alice", "city")
	city, _ := got.String()
	fmt.Println("alice has city:", ok)
	fmt.Println("alice.city:", city)
}

Output:
alice has city: true
alice.city: Lisbon

func WriteWithPropsCtx ¶

func WriteWithPropsCtx(ctx context.Context, w io.Writer, g *lpg.Graph[string, int64]) (int, error)

WriteWithPropsCtx is the context-aware variant of WriteWithProps. ctx.Err() is checked every 4096 records.