ref

package

Go to main page

Versions in this module

v0

v0.7.0

Oct 8, 2024

v0.6.3

Sep 16, 2024

v0.6.2

Aug 27, 2024

v0.6.1

Aug 27, 2024

v0.6.0

Jun 11, 2024

Changes in this version

type Book

+ func (b Book) Clone() Book

type BookAbbreviation

+ Singular string

type BookAbbreviations

+ func (b *BookAbbreviations) SingularName(name string) (string, error)

type Canon

+ func (c *Canon) Clone() *Canon

+ func (c *Canon) Filtered(exclude ...string) (*Canon, error)

type RandomReferenceOption

+ func ExcludeReferences(verses ...string) RandomReferenceOption

type ResolveOption

+ func AsSingleChapter() ResolveOption

type Resolved

+ func (r *Resolved) IsSingleChapter() bool

+ func (r *Resolved) Subtract(s *Resolved) []Resolved

+ type UnknownCategoryError struct

+ Category string

+ Possibilities []string

+ func (o *UnknownCategoryError) Error() string

v0.5.1

Feb 20, 2024

v0.5.0

Feb 20, 2024

Changes in this version

+ var Abbreviations = &BookAbbreviations

+ type AbbrTree struct

+ Children map[rune]*AbbrTree

+ Final map[string]*BookAbbreviation

+ func NewAbbrTree(abbrs *BookAbbreviations) *AbbrTree

+ func (t *AbbrTree) Get(abbr string) map[string]*BookAbbreviation

type Absolute

+ AbbreviatedRef func(...ResolveOption) (string, error)

+ FullNameRef func(...ResolveOption) (string, error)

type Book

+ func (b Book) LastVerseInChapter(n int) (int, error)

+ type BookAbbreviation struct

+ Accepts []string

+ Name string

+ Ordinal int

+ Preferred string

+ type BookAbbreviations struct

+ Abbreviations []BookAbbreviation

+ func (b *BookAbbreviations) BookName(in string) (string, error)

+ func (b *BookAbbreviations) PreferredAbbreviation(name string) (string, error)

type Multiple

+ func (m *Multiple) AbbreviatedRef(opt ...ResolveOption) (string, error)

+ func (m *Multiple) FullNameRef(opt ...ResolveOption) (string, error)

+ type MultipleMatchError struct

+ Input string

+ Matches []string

+ func (m *MultipleMatchError) Error() string

type Proper

+ func (p *Proper) AbbreviatedRef(opt ...ResolveOption) (string, error)

+ func (p *Proper) FullNameRef(opt ...ResolveOption) (string, error)

+ type ResolveOption func(*resolveOpts)

+ func WithAbbreviations(abbrs *BookAbbreviations) ResolveOption

+ func WithoutAbbreviations() ResolveOption

type Resolved

+ func (r *Resolved) AbbreviatedRef(opt ...ResolveOption) (string, error)

+ func (r *Resolved) CompactRef() (string, error)

+ func (r *Resolved) FullNameRef(...ResolveOption) (string, error)

v0.4.0

Feb 1, 2024

Changes in this version

type RandomReferenceOption

+ func WithAtLeast(n uint) RandomReferenceOption

+ func WithAtMost(n uint) RandomReferenceOption

v0.3.0

Jan 22, 2024

v0.2.0

Jan 19, 2024

v0.1.0

Jan 18, 2024

v0.0.0

Jan 17, 2024

Changes in this version

+ const FollowingBookNotation

+ const FollowingChapterNotation

+ const FollowingNotation

+ var Canonical = &Canon

+ var ErrNotFound = errors.New("scripture reference not found")

+ var ErrParseFail = errors.New("parse failed")

+ var ErrWideRange = errors.New("last verse is after the end of the book")

+ func ValidFollowing(n Following) bool

+ type Absolute interface

+ IsSingleRange func() bool

+ Names func() []string

+ type AndFollowing struct

+ Following Following

+ Verse Verse

+ func ParseAndFollowing(ref string) (*AndFollowing, error)

+ func (v *AndFollowing) InBook(b string) *Proper

+ func (v *AndFollowing) Ref() string

+ func (v *AndFollowing) Validate() error

+ type Book struct

+ JustVerse bool

+ Name string

+ Verses []Verse

+ func RandomCanonical(c *Canon) *Book

+ func (b Book) Contains(v Verse) bool

+ func (b Book) Sub(first, last Verse) ([]Verse, error)

+ type CV struct

+ Chapter int

+ Verse int

+ func ParseCV(ref string) (CV, error)

+ func (v CV) Before(ov Verse) bool

+ func (v CV) Equal(ov Verse) bool

+ func (v CV) InBook(b string) *Proper

+ func (v CV) Ref() string

+ func (v CV) RelativeTo(ov Verse) Verse

+ func (v CV) Validate() error

+ type Canon struct

+ Books []Book

+ Categories map[string][]string

+ Name string

+ func (c *Canon) Book(name string) (*Book, error)

+ func (c *Canon) Category(name string) ([]*Pericope, error)

+ func (c *Canon) Resolve(ref Absolute) ([]Resolved, error)

+ type Following int

+ const FollowingRemainingBook

+ const FollowingRemainingChapter

+ type MoreInputError struct

+ Remaining string

+ func (e *MoreInputError) Error() string

+ type Multiple struct

+ Refs []Ref

+ func ParseMultiple(ref string) (*Multiple, error)

+ func (m *Multiple) IsSingleRange() bool

+ func (m *Multiple) Names() []string

+ func (m *Multiple) Ref() string

+ func (m *Multiple) Validate() error

+ type N struct

+ Number int

+ func ParseN(ref string) (N, error)

+ func (n N) Before(ov Verse) bool

+ func (n N) Equal(ov Verse) bool

+ func (n N) InBook(b string) *Proper

+ func (n N) Ref() string

+ func (n N) RelativeTo(ov Verse) Verse

+ func (n N) Validate() error

+ type Pericope struct

+ Canon *Canon

+ Ref *Resolved

+ Title string

+ func Lookup(c *Canon, ref, title string) (*Pericope, error)

+ func (p *Pericope) Verses() (<-chan Verse, error)

+ type Proper struct

+ Book string

+ Verse Relative

+ func NewProper(book string, verse Relative) *Proper

+ func ParseProper(ref string) (*Proper, error)

+ func (p *Proper) IsSingleRange() bool

+ func (p *Proper) Names() []string

+ func (p *Proper) Ref() string

+ func (p *Proper) Validate() error

+ type RandomReferenceOption func(*randomOpts)

+ func FromBook(name string) RandomReferenceOption

+ func FromCanon(canon *Canon) RandomReferenceOption

+ func FromCategory(name string) RandomReferenceOption

+ type Range struct

+ First Verse

+ Last Verse

+ func ParseRange(ref string) (*Range, error)

+ func (r *Range) InBook(b string) *Proper

+ func (r *Range) Ref() string

+ func (r *Range) Validate() error

+ type Ref interface

+ Ref func() string

+ Validate func() error

+ type Related struct

+ Refs []Relative

+ func ParseRelated(ref string) (*Related, error)

+ func (r *Related) InBook(b string) *Proper

+ func (r *Related) Ref() string

+ func (r *Related) Validate() error

+ type Relative interface

+ InBook func(string) *Proper

+ type Resolved struct

+ Book *Book

+ First Verse

+ Last Verse

+ func Random(opt ...RandomReferenceOption) (*Resolved, error)

+ func (r *Resolved) IsSingleRange() bool

+ func (r *Resolved) Names() []string

+ func (r *Resolved) Ref() string

+ func (r *Resolved) Validate() error

+ func (r *Resolved) Verses() []Verse

+ type Single struct

+ Verse Verse

+ func ParseSingle(ref string) (*Single, error)

+ func (v *Single) InBook(b string) *Proper

+ func (v *Single) Ref() string

+ func (v *Single) Validate() error

+ type ValidationError struct

+ Cause error

+ func (e *ValidationError) Error() string

+ func (e *ValidationError) Unwrap() error

+ type Verse interface

+ Before func(Verse) bool

+ Equal func(Verse) bool

+ RelativeTo func(Verse) Verse

+ func RandomPassage(b *Book) []Verse

+ func RandomPassageFromRef(b *Resolved) []Verse

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