ibeam

Documentation

Overview

Package ibeam provides I-beam (⌶) lookup from two sources:

1. Public Dyalog documentation (from the cached docs DB)
2. Private/undocumented I-beams (from ~/.config/gritt/ibeams.csv)

The private CSV is for Dyalog developers — it may contain internal I-beams not in the public docs.

Index

• type Entry
  • func All(db *sql.DB) []Entry
  • func Lookup(db *sql.DB, number int) *Entry
  • func Search(db *sql.DB, query string) []Entry

Types

type Entry

type Entry struct {
	Number      int    // The I-beam number (e.g. 220)
	Name        string // Short name (e.g. "Serialise/Deserialise Array")
	Signature   string // Full signature (e.g. "R←X(220⌶)Y")
	Source      string // "docs" or "private"
	DocPath     string // Path in docs DB (empty for private entries)
	Description string // Brief description (from CSV, or empty for docs entries)
}

Entry represents a single I-beam.

func All

func All(db *sql.DB) []Entry

All returns every known I-beam, sorted by number.

func Lookup

func Lookup(db *sql.DB, number int) *Entry

Lookup finds a specific I-beam by number.

func Search

func Search(db *sql.DB, query string) []Entry

Search finds I-beams matching a query. Searches both public docs and the private CSV. Results are sorted by I-beam number, deduplicated (private entries supplement but don't replace public ones).