spec

Jun 10, 2026

Changes in this version

+ type MissingClonedEntityError struct

+ Entity types.Entity

+ Field *matter.Field

+ func (mcee *MissingClonedEntityError) Error() string

+ func (mcee *MissingClonedEntityError) Origin() (path string, line int)

+ func (mcee *MissingClonedEntityError) Type() ErrorType

type Specification

+ func (spec *Specification) ResolveDataTypeReferences()

Jun 4, 2026

Changes in this version

+ func TraverseEntities(spec *Specification, ...)

+ type EntityCallback func(parent types.Entity, entity types.Entity) parse.SearchShould

type ParserOptions

+ ErrataOverlayPath string

May 27, 2026

Changes in this version

type ParserOptions

+ ErrataPath string

Mar 25, 2026

Changes in this version

type Builder

+ func (sp *Builder) ResolveConformances()

type Specification

+ func (spec *Specification) ResolveConformances()

Dec 23, 2025

Changes in this version

type EntityRefs

+ func (cr *EntityRefs[T]) Remove(c T, m types.Entity)

Nov 20, 2025

Changes in this version

type ViolationType

+ const ViolationMasterList

Nov 6, 2025

Changes in this version

+ func AssignDocType(sectionInfoCache SectionInfoCache, docInfoCache DocumentInfoCache, ...) error

+ func DefaultColumnValue(reader asciidoc.Reader, ti *TableInfo, row *asciidoc.TableRow, ...) string

type Anchor

+ Library *Library

type BuilderOption

+ func PatchForSdk(patch bool) BuilderOption

+ type ConformanceChoiceMismatchError struct

+ ChoiceLimit conformance.ChoiceLimit

+ Entity types.Entity

+ Previous types.Entity

+ PreviousChoiceLimit conformance.ChoiceLimit

+ Set string

+ Source log.Source

+ func (ccme ConformanceChoiceMismatchError) Error() string

+ func (ccme ConformanceChoiceMismatchError) Origin() (path string, line int)

+ func (ccme ConformanceChoiceMismatchError) Type() ErrorType

+ type ConformanceChoiceOrphanError struct

+ Set string

+ Source log.Source

+ func (ccoe ConformanceChoiceOrphanError) Error() string

+ func (ccoe ConformanceChoiceOrphanError) Origin() (path string, line int)

+ func (ccoe ConformanceChoiceOrphanError) Type() ErrorType

+ type DocCache struct

+ func NewDocCache(root string) *DocCache

+ func (dc DocCache) Add(doc *asciidoc.Document)

type DocSet

+ func LoadSpecDocs(cxt context.Context, parserOptions ParserOptions, ...) (specDocs DocSet, err error)

+ type DocumentInfoCache interface

+ DocType func(document *asciidoc.Document) (matter.DocType, error)

+ Parents func(document *asciidoc.Document) []*asciidoc.Document

+ SetDocType func(document *asciidoc.Document, docType matter.DocType)

type ErrorType

+ const ErrorTypeConformanceChoiceMismatch

+ const ErrorTypeConformanceChoiceOrphan

+ type Library struct

+ Docs []*asciidoc.Document

+ Errata *errata.Collection

+ Root *asciidoc.Document

+ Spec *Specification

+ func NewLibrary(root *asciidoc.Document, config config.Library, errata *errata.Collection, ...) *Library

+ func (library *Library) Anchors(reader asciidoc.Reader) (map[string][]*Anchor, error)

+ func (library *Library) CrossReferences(id string) []*CrossReference

+ func (library *Library) CrossReferencesForDoc(doc *asciidoc.Document) map[string][]*CrossReference

+ func (library *Library) DiscoErrata(path string) *errata.Disco

+ func (library *Library) DocType(doc *asciidoc.Document) (matter.DocType, error)

+ func (library *Library) EntitiesForElement(element asciidoc.Attributable) (entities []types.Entity, ok bool)

+ func (library *Library) ErrataForPath(docPath string) *errata.Errata

+ func (library *Library) FindAnchor(id string, source log.Source) *Anchor

+ func (library *Library) FindAnchorByID(id asciidoc.Elements, element asciidoc.ParentElement, source log.Source) *Anchor

+ func (library *Library) FindAnchors(id string) []*Anchor

+ func (library *Library) FindSectionByType(reader asciidoc.Reader, doc *asciidoc.Document, top *asciidoc.Section, ...) *asciidoc.Section

+ func (library *Library) GetHeaderCellString(reader asciidoc.Reader, cell *asciidoc.TableCell) (string, error)

+ func (library *Library) Identifier(parent asciidoc.Parent, element asciidoc.Element, id asciidoc.Elements) string

+ func (library *Library) IsUtilityPath(path asciidoc.Path) bool

+ func (library *Library) Parents(doc *asciidoc.Document) []*asciidoc.Document

+ func (library *Library) Preparse(specRoot string, attributes []asciidoc.AttributeName) (err error)

+ func (library *Library) SdkErrata(path string) *errata.SDK

+ func (library *Library) SectionLevel(s *asciidoc.Section) (level int)

+ func (library *Library) SectionName(s *asciidoc.Section) (name string)

+ func (library *Library) SectionType(s *asciidoc.Section) (st matter.Section)

+ func (library *Library) SetDocType(doc *asciidoc.Document, dt matter.DocType)

+ func (library *Library) SetSectionLevel(s *asciidoc.Section, level int)

+ func (library *Library) SetSectionName(s *asciidoc.Section, name string)

+ func (library *Library) SetSectionType(s *asciidoc.Section, st matter.Section)

+ func (library *Library) SpecErrata(path string) *errata.Spec

+ func (library *Library) SyncCrossReference(cr *CrossReference, id asciidoc.Elements)

+ func (library *Library) SyncToDoc(a *Anchor, id asciidoc.Elements)

+ type LibraryBuilder struct

+ func NewLibraryBuilder(specRoot string, config *config.Config, errata *errata.Collection) *LibraryBuilder

+ func (lb *LibraryBuilder) Process(cxt context.Context, inputs []*pipeline.Data[*asciidoc.Document]) (outputs []*pipeline.Data[*Library], err error)

+ func (lb LibraryBuilder) Name() string

+ type LibraryParser struct

+ func NewLibraryParser(specRoot string, attributes []asciidoc.AttributeName) (*LibraryParser, error)

+ func (r LibraryParser) Name() string

+ func (r LibraryParser) Process(cxt context.Context, input *pipeline.Data[*Library], index int32, total int32) (outputs []*pipeline.Data[*asciidoc.Document], ...)

+ type LibrarySet pipeline.Map[string, *pipeline.Data[*Library]]

type Reader

+ func (p Reader) Targets(cxt context.Context) ([]string, error)

+ type SectionInfoCache interface

+ ErrataForPath func(docPath string) *errata.Errata

+ SectionName func(section *asciidoc.Section) string

+ SectionType func(section *asciidoc.Section) matter.Section

+ SetSectionName func(section *asciidoc.Section, name string)

+ SetSectionType func(section *asciidoc.Section, sectionType matter.Section)

type Specification

+ Config *config.Config

+ Errata *errata.Collection

+ Libraries []*Library

+ LibraryRefs map[types.Entity]*Library

+ UnusedDocs []*asciidoc.Document

+ func (s *Specification) EntitiesForDocument(doc *asciidoc.Document) []types.Entity

+ func (s *Specification) LibraryForDocument(doc *asciidoc.Document) (library *Library, ok bool)

type TableInfo

+ func (ti *TableInfo) AppendColumn(reader asciidoc.Reader, column matter.TableColumn, entityType types.EntityType) (appendedIndex int, err error)

Oct 23, 2025

Changes in this version

+ func MergeViolations(v1, v2 map[string][]Violation) (v map[string][]Violation)

type FabricScopedStructNotAllowedError

+ func (cf FabricScopedStructNotAllowedError) ComparableEntity() types.ComparableEntity

type FabricScopingNotAllowedError

+ func (cf FabricScopingNotAllowedError) ComparableEntity() types.ComparableEntity

type FabricSensitivityNotAllowedError

+ func (cf FabricSensitivityNotAllowedError) ComparableEntity() types.ComparableEntity

+ type SpecPullRequest struct

+ Base *Specification

+ BaseInProgress *Specification

+ Head *Specification

+ HeadInProgress *Specification

+ func LoadSpecPullRequest(cxt context.Context, baseRoot string, headRoot string, docPaths []string, ...) (ss SpecPullRequest, err error)

type UnknownConformanceIdentifierError

+ func (cf UnknownConformanceIdentifierError) ComparableEntity() types.ComparableEntity

type UnknownConformanceReferenceError

+ func (cf UnknownConformanceReferenceError) ComparableEntity() types.ComparableEntity

+ type Violation struct

+ Entity types.Entity

+ Line int

+ Path string

+ Text string

+ Type ViolationType

+ type ViolationType uint8

+ const ViolationNewParseError

+ const ViolationTypeNonProvisional

+ const ViolationTypeNone

+ const ViolationTypeNotIfDefd

+ func (vt ViolationType) Has(o ViolationType) bool

+ func (vt ViolationType) String() string

Sep 5, 2025

Changes in this version

+ func AssignSectionNames(doc *Doc) error

+ type NamespaceNameMismatchTagRequirementError struct

+ Namespace *matter.Namespace

+ Requirement *matter.TagRequirement

+ func (ddt NamespaceNameMismatchTagRequirementError) Error() string

+ func (ddt NamespaceNameMismatchTagRequirementError) Origin() (path string, line int)

+ func (ddt NamespaceNameMismatchTagRequirementError) Type() ErrorType

+ type TagNameMismatchTagRequirementError struct

+ Requirement *matter.TagRequirement

+ SemanticTag *matter.SemanticTag

+ func (ddt TagNameMismatchTagRequirementError) Error() string

+ func (ddt TagNameMismatchTagRequirementError) Origin() (path string, line int)

+ func (ddt TagNameMismatchTagRequirementError) Type() ErrorType

+ type UnknownComposingDeviceTypeTagRequirementDeviceTypeError struct

+ Requirement *matter.DeviceTypeTagRequirement

+ func (ddt UnknownComposingDeviceTypeTagRequirementDeviceTypeError) Error() string

+ func (ddt UnknownComposingDeviceTypeTagRequirementDeviceTypeError) Origin() (path string, line int)

+ func (ddt UnknownComposingDeviceTypeTagRequirementDeviceTypeError) Type() ErrorType

+ type UnknownNamespaceTagRequirementError struct

+ Requirement *matter.TagRequirement

+ func (ddt UnknownNamespaceTagRequirementError) Error() string

+ func (ddt UnknownNamespaceTagRequirementError) Origin() (path string, line int)

+ func (ddt UnknownNamespaceTagRequirementError) Type() ErrorType

+ type UnknownTagRequirementError struct

+ Requirement *matter.TagRequirement

+ func (ddt UnknownTagRequirementError) Error() string

+ func (ddt UnknownTagRequirementError) Origin() (path string, line int)

+ func (ddt UnknownTagRequirementError) Type() ErrorType

Sep 4, 2025

Changes in this version

type ErrorType

+ const ErrorTypeNamespaceNameMismatch

+ const ErrorTypeTagRequirementNamespaceNameMismatch

+ const ErrorTypeTagRequirementTagNameMismatch

+ const ErrorTypeTagRequirementUnknownNamespace

+ const ErrorTypeTagRequirementUnknownTag

+ const ErrorTypeTagRequirementUnreferencedDeviceType

+ type NamespaceNameMismatchTagRequirementDeviceTypeError struct

+ Namespace *matter.Namespace

+ Requirement *matter.DeviceTypeTagRequirement

+ func (ddt NamespaceNameMismatchTagRequirementDeviceTypeError) Error() string

+ func (ddt NamespaceNameMismatchTagRequirementDeviceTypeError) Origin() (path string, line int)

+ func (ddt NamespaceNameMismatchTagRequirementDeviceTypeError) Type() ErrorType

+ type TagNameMismatchTagRequirementDeviceTypeError struct

+ Requirement *matter.DeviceTypeTagRequirement

+ SemanticTag *matter.SemanticTag

+ func (ddt TagNameMismatchTagRequirementDeviceTypeError) Error() string

+ func (ddt TagNameMismatchTagRequirementDeviceTypeError) Origin() (path string, line int)

+ func (ddt TagNameMismatchTagRequirementDeviceTypeError) Type() ErrorType

+ type UnknownNamespaceTagRequirementDeviceTypeError struct

+ Requirement *matter.DeviceTypeTagRequirement

+ func (ddt UnknownNamespaceTagRequirementDeviceTypeError) Error() string

+ func (ddt UnknownNamespaceTagRequirementDeviceTypeError) Origin() (path string, line int)

+ func (ddt UnknownNamespaceTagRequirementDeviceTypeError) Type() ErrorType

+ type UnknownTagRequirementDeviceTypeError struct

+ Requirement *matter.DeviceTypeTagRequirement

+ func (ddt UnknownTagRequirementDeviceTypeError) Error() string

+ func (ddt UnknownTagRequirementDeviceTypeError) Origin() (path string, line int)

+ func (ddt UnknownTagRequirementDeviceTypeError) Type() ErrorType

+ type UnreferencedTagRequirementDeviceTypeError struct

+ Requirement *matter.DeviceTypeTagRequirement

+ func (ddt UnreferencedTagRequirementDeviceTypeError) Error() string

+ func (ddt UnreferencedTagRequirementDeviceTypeError) Origin() (path string, line int)

+ func (ddt UnreferencedTagRequirementDeviceTypeError) Type() ErrorType

Aug 24, 2025

Changes in this version

+ func Build(cxt context.Context, parserOptions ParserOptions, ...) (specification *Specification, specDocs DocSet, err error)

+ func BuildDocumentGroups(cxt context.Context, parserOptions ParserOptions, ...) (docGroups DocGroupSet, specDocs DocSet, err error)

+ func PreParse(cxt context.Context, parserOptions ParserOptions, ...) (err error)

+ type DocGroupSet pipeline.Map[string, *pipeline.Data[*DocGroup]]

Aug 19, 2025

Changes in this version

+ func GetDataType(doc *Doc, s *asciidoc.Section) *types.DataType

+ func Read(cxt context.Context, processingOptions pipeline.ProcessingOptions, ...) (specification *Specification, specDocs DocSet, err error)

type Anchor

+ func (a *Anchor) Identifier(reader asciidoc.Reader) string

type BuilderOptions

+ func (bo BuilderOptions) List() (options []BuilderOption)

type CrossReference

+ func (cr *CrossReference) Identifier(reader asciidoc.Reader) string

type Doc

+ func ParseFile(path asciidoc.Path, specRoot string, attributes ...asciidoc.AttributeName) (*Doc, error)

+ func (d *Doc) FindAnchorByID(id asciidoc.Elements, element asciidoc.ParentElement, source log.Source) *Anchor

+ func (doc *Doc) Append(e ...asciidoc.Element)

+ func (doc *Doc) Children() asciidoc.Elements

+ func (doc *Doc) Reader() asciidoc.Reader

+ func (doc *Doc) SectionName(s *asciidoc.Section) (name string)

+ func (doc *Doc) SectionType(s *asciidoc.Section) (st matter.Section)

+ func (doc *Doc) SetChildren(e asciidoc.Elements)

+ func (doc *Doc) SetSectionName(s *asciidoc.Section, name string)

+ func (doc *Doc) SetSectionType(s *asciidoc.Section, st matter.Section)

type DocGroup

+ Reader asciidoc.Reader

+ type DocumentGrouper struct

+ func NewDocumentGrouper(specRoot string) *DocumentGrouper

+ func (dg *DocumentGrouper) Process(cxt context.Context, inputs []*pipeline.Data[*Doc]) (outputs []*pipeline.Data[*DocGroup], err error)

+ func (dg DocumentGrouper) Name() string

+ type PreParseReader struct

+ func (ppi *PreParseReader) Count(elements asciidoc.Elements) int

+ func (ppi *PreParseReader) Iterate(parent asciidoc.Parent, elements asciidoc.Elements) asciidoc.ElementIterator

+ type PreParser struct

+ func NewPreParser(specRoot string, attributes []asciidoc.AttributeName) (*PreParser, error)

+ func (r PreParser) Name() string

+ func (r PreParser) Process(cxt context.Context, input *pipeline.Data[*DocGroup], index int32, total int32) (outputs []*pipeline.Data[asciidoc.Reader], extras []*pipeline.Data[*DocGroup], ...)

type TableInfo

+ func (ti *TableInfo) ReadNameAtOffset(row *asciidoc.TableRow, offset int) (name string, xref *asciidoc.CrossReference, err error)

Aug 3, 2025

Changes in this version

type Section

+ func (s *Section) Position() (line int, column int, offset int)

Aug 1, 2025

Changes in this version

type ErrorType

+ const ErrorTypeConditionRequirementUnknownCondition

+ const ErrorTypeConditionRequirementUnknownDeviceType

+ const ErrorTypeConditionRequirementUnreferencedDeviceType

+ const ErrorTypeGenericParse

+ type GenericParseError struct

+ Source log.Source

+ func (gpe GenericParseError) Origin() (path string, line int)

+ func (gpe GenericParseError) Type() ErrorType

type Specification

+ RootNodeDeviceType *matter.DeviceType

type TableInfo

+ func (ti *TableInfo) ContentRows() iter.Seq[*asciidoc.TableRow]

+ type UnknownConditionRequirementConditionError struct

+ Requirement *matter.ConditionRequirement

+ func (ddt UnknownConditionRequirementConditionError) Error() string

+ func (ddt UnknownConditionRequirementConditionError) Origin() (path string, line int)

+ func (ddt UnknownConditionRequirementConditionError) Type() ErrorType

+ type UnknownConditionRequirementDeviceTypeError struct

+ Requirement *matter.ConditionRequirement

+ func (ddt UnknownConditionRequirementDeviceTypeError) Error() string

+ func (ddt UnknownConditionRequirementDeviceTypeError) Origin() (path string, line int)

+ func (ddt UnknownConditionRequirementDeviceTypeError) Type() ErrorType

+ type UnreferencedConditionRequirementDeviceTypeError struct

+ Requirement *matter.ConditionRequirement

+ func (ddt UnreferencedConditionRequirementDeviceTypeError) Error() string

+ func (ddt UnreferencedConditionRequirementDeviceTypeError) Origin() (path string, line int)

+ func (ddt UnreferencedConditionRequirementDeviceTypeError) Type() ErrorType

Jun 24, 2025

Changes in this version

+ var ErrNoTableFound = fmt.Errorf("no table found")

+ var ErrNotEnoughRowsInTable = fmt.Errorf("not enough value rows in table")

+ func AccessToASCIIDocString(a matter.Access, entityType types.EntityType) string

+ func AssignSectionTypes(doc *Doc, top *Section) error

+ func CanonicalName(name string) string

+ func DeriveSpecPathFromPaths(paths []string) string

+ func FindFirstTable(section *Section) *asciidoc.Table

+ func NewPreparseContext(path asciidoc.Path, specRoot string, attributes ...asciidoc.AttributeName) parse.PreParseContext

+ func NewSource(d *Doc, e asciidoc.Element) *source

+ func NewSpecPath(path string, rootPath string) (asciidoc.Path, error)

+ func ParseAccess(vc string, entityType types.EntityType) (a matter.Access, parsed bool)

+ func ParseCommandDirection(s string) matter.Interface

+ func PatchSpecForSdk(spec *Specification) error

+ func ReferenceName(element any) string

+ func RenderTableCell(cell *asciidoc.TableCell) (string, error)

+ func Targeter(specRoot string) func(cxt context.Context) ([]string, error)

+ func Validate(spec *Specification)

+ type Anchor struct

+ Document *Doc

+ Element asciidoc.Element

+ ID string

+ LabelElements asciidoc.Set

+ Parent parse.HasElements

+ Source matter.Source

+ func NewAnchor(doc *Doc, id string, element asciidoc.Element, parent parse.HasElements, ...) *Anchor

+ func (a *Anchor) Name() string

+ func (a *Anchor) SyncToDoc(id string)

+ type Builder struct

+ Spec *Specification

+ func NewBuilder(specRoot string, options ...BuilderOption) Builder

+ func (sp *Builder) Process(cxt context.Context, inputs []*pipeline.Data[*Doc]) (outputs []*pipeline.Data[*Doc], err error)

+ func (sp Builder) Name() string

+ type BuilderOption func(tg *Builder)

+ func IgnoreHierarchy(ignore bool) BuilderOption

+ type BuilderOptions struct

+ IgnoreHierarchy bool

+ type CellRenderer func(cellElements asciidoc.Set, sb *strings.Builder) (source asciidoc.Element)

+ type ClusterReferenceNameMismatch struct

+ Cluster *matter.Cluster

+ Name string

+ Source log.Source

+ func (ddt ClusterReferenceNameMismatch) Error() string

+ func (ddt ClusterReferenceNameMismatch) Origin() (path string, line int)

+ func (ddt ClusterReferenceNameMismatch) Type() ErrorType

+ type ColumnIndex map[matter.TableColumn]int

+ func (ci ColumnIndex) HasAll(columns ...matter.TableColumn) bool

+ func (ci ColumnIndex) HasAny(columns ...matter.TableColumn) bool

+ type CrossReference struct

+ Document *Doc

+ Parent parse.HasElements

+ Reference *asciidoc.CrossReference

+ Source matter.Source

+ func (cr *CrossReference) SyncToDoc(id string)

+ type DeviceTypeReferenceNameMismatch struct

+ DeviceType *matter.DeviceType

+ Name string

+ Source log.Source

+ func (ddt DeviceTypeReferenceNameMismatch) Error() string

+ func (ddt DeviceTypeReferenceNameMismatch) Origin() (path string, line int)

+ func (ddt DeviceTypeReferenceNameMismatch) Type() ErrorType

+ type DeviceTypeSet pipeline.Map[string, *pipeline.Data[[]*matter.DeviceType]]

+ type Doc struct

+ Base *asciidoc.Document

+ Domain matter.Domain

+ Path asciidoc.Path

+ func Parse(path asciidoc.Path, specRoot string, attributes ...asciidoc.AttributeName) (*Doc, error)

+ func ReadFile(path string, rootPath string) (*Doc, error)

+ func (d *Doc) EntitiesForSection(section *asciidoc.Section) ([]types.Entity, bool)

+ func (d *Doc) FindAnchor(id string, source log.Source) *Anchor

+ func (d *Doc) FindAnchors(id string) []*Anchor

+ func (d *Doc) GetHeaderCellString(cell *asciidoc.TableCell) (string, error)

+ func (doc *Doc) Anchors() (map[string][]*Anchor, error)

+ func (doc *Doc) CrossReferences() map[string][]*CrossReference

+ func (doc *Doc) DocType() (matter.DocType, error)

+ func (doc *Doc) Entities() (entities []types.Entity, err error)

+ func (doc *Doc) Equals(other asciidoc.Element) bool

+ func (doc *Doc) Errata() *errata.Errata

+ func (doc *Doc) Footnotes() []*asciidoc.Footnote

+ func (doc *Doc) GlobalObjects() (entities []types.Entity, err error)

+ func (doc *Doc) Group() *DocGroup

+ func (doc *Doc) OrderedEntities() (entities []types.Entity, err error)

+ func (doc *Doc) Parents() []*Doc

+ func (doc *Doc) Reference(ref string) (types.Entity, bool)

+ func (doc *Doc) Type() asciidoc.ElementType

+ type DocGroup struct

+ Docs []*Doc

+ Root string

+ func NewDocGroup(root string) *DocGroup

+ func (dg *DocGroup) Anchors(id string) []*Anchor

+ func (dg *DocGroup) CrossReferences(id string) []*CrossReference

+ type DocSet pipeline.Map[string, *pipeline.Data[*Doc]]

+ func NewDocSet() DocSet

+ type DuplicateEntityIDError struct

+ Entity types.Entity

+ Previous types.Entity

+ func (ddt DuplicateEntityIDError) Error() string

+ func (ddt DuplicateEntityIDError) Origin() (path string, line int)

+ func (ddt DuplicateEntityIDError) Type() ErrorType

+ type DuplicateEntityNameError struct

+ Entity types.Entity

+ Previous types.Entity

+ func (ddt DuplicateEntityNameError) Error() string

+ func (ddt DuplicateEntityNameError) Origin() (path string, line int)

+ func (ddt DuplicateEntityNameError) Type() ErrorType

+ type ElementRequirementUnknownElementError struct

+ Requirement *matter.ElementRequirement

+ func (ddt ElementRequirementUnknownElementError) Error() string

+ func (ddt ElementRequirementUnknownElementError) Origin() (path string, line int)

+ func (ddt ElementRequirementUnknownElementError) Type() ErrorType

+ type ElementRequirementUnreferencedClusterError struct

+ Requirement *matter.ElementRequirement

+ func (ddt ElementRequirementUnreferencedClusterError) Error() string

+ func (ddt ElementRequirementUnreferencedClusterError) Origin() (path string, line int)

+ func (ddt ElementRequirementUnreferencedClusterError) Type() ErrorType

+ type EntityRefs struct

+ func NewEntityRefs[T comparable]() EntityRefs[T]

+ func (cr *EntityRefs[T]) Add(c T, m types.Entity)

+ func (cr *EntityRefs[T]) Get(m types.Entity) (pipeline.Map[T, struct{}], bool)

+ type Error interface

+ Error func() string

+ Type func() ErrorType

+ type ErrorType uint16

+ const ErrorTypeClusterReferenceNameMismatch

+ const ErrorTypeComposingDeviceTypeClusterRequirementUnknownCluster

+ const ErrorTypeComposingDeviceTypeClusterRequirementUnknownDeviceType

+ const ErrorTypeComposingDeviceTypeClusterRequirementUnreferencedDeviceType

+ const ErrorTypeComposingDeviceTypeElementRequirementUnknownCluster

+ const ErrorTypeComposingDeviceTypeElementRequirementUnknownDeviceType

+ const ErrorTypeComposingDeviceTypeElementRequirementUnreferencedDeviceType

+ const ErrorTypeComposingDeviceTypeRequirementUnknownDeviceType

+ const ErrorTypeDeviceTypeReferenceNameMismatch

+ const ErrorTypeDuplicateEntityID

+ const ErrorTypeDuplicateEntityName

+ const ErrorTypeElementRequirementUnknownElement

+ const ErrorTypeElementRequirementUnreferencedCluster

+ const ErrorTypeFabricScopedStructNotAllowed

+ const ErrorTypeFabricScopingNotAllowed

+ const ErrorTypeFabricSensitivityNotAllowed

+ const ErrorTypeInvalidConformance

+ const ErrorTypeInvalidConstraint

+ const ErrorTypeInvalidFallback

+ const ErrorTypeUnknown

+ const ErrorTypeUnknownBaseCluster

+ const ErrorTypeUnknownClusterRequirement

+ const ErrorTypeUnknownConformanceIdentifier

+ const ErrorTypeUnknownConformanceReference

+ const ErrorTypeUnknownConstraintIdentifier

+ const ErrorTypeUnknownConstraintReference

+ const ErrorTypeUnknownCustomDataType

+ const ErrorTypeUnknownElementRequirementCluster

+ const ErrorTypeUnknownSuperset

+ type ExtraColumn struct

+ Name string

+ Offset int

+ type FabricScopedStructNotAllowedError struct

+ Entity types.Entity

+ func (cf FabricScopedStructNotAllowedError) Origin() (path string, line int)

+ func (cf FabricScopedStructNotAllowedError) Type() ErrorType

+ func (ddt FabricScopedStructNotAllowedError) Error() string

+ type FabricScopingNotAllowedError struct

+ Entity types.Entity

+ func (cf FabricScopingNotAllowedError) Origin() (path string, line int)

+ func (cf FabricScopingNotAllowedError) Type() ErrorType

+ func (ddt FabricScopingNotAllowedError) Error() string

+ type FabricSensitivityNotAllowedError struct

+ Entity types.Entity

+ func (cf FabricSensitivityNotAllowedError) Origin() (path string, line int)

+ func (cf FabricSensitivityNotAllowedError) Type() ErrorType

+ func (ddt FabricSensitivityNotAllowedError) Error() string

+ type FilterOptions struct

+ Exclude []string

+ Force bool

+ IgnoreErrored bool

+ Paths []string

+ type InvalidConformanceError struct

+ Conformance string

+ Source log.Source

+ func (cf InvalidConformanceError) Origin() (path string, line int)

+ func (cf InvalidConformanceError) Type() ErrorType

+ func (ddt InvalidConformanceError) Error() string

+ type InvalidConstraintError struct

+ Constraint string

+ Source log.Source

+ func (cf InvalidConstraintError) Origin() (path string, line int)

+ func (cf InvalidConstraintError) Type() ErrorType

+ func (ddt InvalidConstraintError) Error() string

+ type InvalidFallbackError struct

+ Fallback string

+ Source log.Source

+ func (cf InvalidFallbackError) Origin() (path string, line int)

+ func (cf InvalidFallbackError) Type() ErrorType

+ func (ddt InvalidFallbackError) Error() string

+ type ParseErrors struct

+ Errors []Error

+ func (pe ParseErrors) Error() string

+ type Parser struct

+ func NewParser(attributes []asciidoc.AttributeName, parserOptions ParserOptions) (Parser, error)

+ func (p Parser) Name() string

+ func (p Parser) Process(cxt context.Context, input *pipeline.Data[struct{}], index int32, total int32) (outputs []*pipeline.Data[*Doc], extras []*pipeline.Data[struct{}], err error)

+ func (p Parser) Targets(cxt context.Context) ([]string, error)

+ type ParserOptions struct

+ Inline bool

+ Root string

+ func (po *ParserOptions) AfterApply() error

+ type Reader struct

+ Root string

+ func NewReader(name string, rootPath string) (Reader, error)

+ func (r Reader) Name() string

+ func (r Reader) Process(cxt context.Context, input *pipeline.Data[struct{}], index int32, total int32) (outputs []*pipeline.Data[*Doc], extras []*pipeline.Data[struct{}], err error)

+ type Section struct

+ Base *asciidoc.Section

+ Doc *Doc

+ Name string

+ Parent any

+ SecType matter.Section

+ func FindSectionByType(top *Section, sectionType matter.Section) *Section

+ func NewSection(doc *Doc, parent any, s *asciidoc.Section) (*Section, error)

+ func (e *Section) Equals(o asciidoc.Element) bool

+ func (s *Section) AppendSection(ns *Section)

+ func (s *Section) GetASCIISection() *asciidoc.Section

+ func (s *Section) GetDataType() *types.DataType

+ func (s *Section) SetElements(elements asciidoc.Set)

+ func (s Section) Type() asciidoc.ElementType

+ type Specification struct

+ BaseDeviceType *matter.DeviceType

+ ClusterRefs EntityRefs[*matter.Cluster]

+ Clusters map[*matter.Cluster]struct{}

+ ClustersByID map[uint64]*matter.Cluster

+ ClustersByName map[string]*matter.Cluster

+ DataTypeRefs EntityRefs[types.Entity]

+ DeviceTypes []*matter.DeviceType

+ DeviceTypesByID map[uint64]*matter.DeviceType

+ DeviceTypesByName map[string]*matter.DeviceType

+ DocGroups []*DocGroup

+ DocRefs map[types.Entity]*Doc

+ Docs map[string]*Doc

+ Errors []Error

+ GlobalObjects types.EntitySet

+ Namespaces []*matter.Namespace

+ Root string

+ func (spec *Specification) BuildClusterReferences()

+ func (spec *Specification) BuildDataTypeReferences()

+ func (spec *Specification) ComposeDeviceType(deviceType *matter.DeviceType) (composition *matter.DeviceTypeComposition, err error)

+ type StringReader struct

+ func NewStringReader(name string, rootPath string) (StringReader, error)

+ func (r StringReader) Name() string

+ func (r StringReader) Process(cxt context.Context, input *pipeline.Data[string], index int32, total int32) (outputs []*pipeline.Data[*Doc], extras []*pipeline.Data[string], err error)

+ type TableInfo struct

+ ColumnMap ColumnIndex

+ Doc *Doc

+ Element *asciidoc.Table

+ ExtraColumns []ExtraColumn

+ HeaderRowIndex int

+ Rows []*asciidoc.TableRow

+ func ReadTable(doc *Doc, table *asciidoc.Table) (ti *TableInfo, err error)

+ func (ti *TableInfo) Body() iter.Seq[*asciidoc.TableRow]

+ func (ti *TableInfo) ColumnIndex(columns ...matter.TableColumn) (index int, ok bool)

+ func (ti *TableInfo) ReadConformance(row *asciidoc.TableRow, column matter.TableColumn) conformance.Set

+ func (ti *TableInfo) ReadConstraint(row *asciidoc.TableRow, columns ...matter.TableColumn) constraint.Constraint

+ func (ti *TableInfo) ReadDataType(row *asciidoc.TableRow, column matter.TableColumn) (*types.DataType, error)

+ func (ti *TableInfo) ReadFallback(row *asciidoc.TableRow, columns ...matter.TableColumn) constraint.Limit

+ func (ti *TableInfo) ReadID(row *asciidoc.TableRow, columns ...matter.TableColumn) (*matter.Number, error)

+ func (ti *TableInfo) ReadLocation(row *asciidoc.TableRow, columns ...matter.TableColumn) (relation matter.DeviceTypeRequirementLocation, err error)

+ func (ti *TableInfo) ReadName(row *asciidoc.TableRow, columns ...matter.TableColumn) (name string, xref *asciidoc.CrossReference, err error)

+ func (ti *TableInfo) ReadQuality(row *asciidoc.TableRow, entityType types.EntityType, ...) (quality matter.Quality, err error)

+ func (ti *TableInfo) ReadString(row *asciidoc.TableRow, columns ...matter.TableColumn) (string, error)

+ func (ti *TableInfo) ReadStringAtOffset(row *asciidoc.TableRow, offset int) (string, error)

+ func (ti *TableInfo) ReadValue(row *asciidoc.TableRow, columns ...matter.TableColumn) (string, error)

+ func (ti *TableInfo) ReadValueByIndex(row *asciidoc.TableRow, offset int) (string, error)

+ func (ti *TableInfo) RenderColumn(row *asciidoc.TableRow, renderer CellRenderer, columns ...matter.TableColumn) (value string, source asciidoc.Element, ok bool)

+ func (ti *TableInfo) Rescan(doc *Doc) (err error)

+ type UnknownBaseClusterError struct

+ Cluster *matter.Cluster

+ func (ddt UnknownBaseClusterError) Error() string

+ func (ddt UnknownBaseClusterError) Origin() (path string, line int)

+ func (ddt UnknownBaseClusterError) Type() ErrorType

+ type UnknownClusterRequirementError struct

+ Requirement *matter.ClusterRequirement

+ func (ddt UnknownClusterRequirementError) Error() string

+ func (ddt UnknownClusterRequirementError) Origin() (path string, line int)

+ func (ddt UnknownClusterRequirementError) Type() ErrorType

+ type UnknownComposingDeviceTypeClusterRequirementDeviceTypeError struct

+ Requirement *matter.DeviceTypeClusterRequirement

+ func (ddt UnknownComposingDeviceTypeClusterRequirementDeviceTypeError) Error() string

+ func (ddt UnknownComposingDeviceTypeClusterRequirementDeviceTypeError) Origin() (path string, line int)

+ func (ddt UnknownComposingDeviceTypeClusterRequirementDeviceTypeError) Type() ErrorType

+ type UnknownComposingDeviceTypeElementRequirementDeviceTypeError struct

+ Requirement *matter.DeviceTypeElementRequirement

+ func (ddt UnknownComposingDeviceTypeElementRequirementDeviceTypeError) Error() string

+ func (ddt UnknownComposingDeviceTypeElementRequirementDeviceTypeError) Origin() (path string, line int)

+ func (ddt UnknownComposingDeviceTypeElementRequirementDeviceTypeError) Type() ErrorType

+ type UnknownComposingDeviceTypeRequirementClusterError struct

+ Requirement *matter.DeviceTypeClusterRequirement

+ func (ddt UnknownComposingDeviceTypeRequirementClusterError) Error() string

+ func (ddt UnknownComposingDeviceTypeRequirementClusterError) Origin() (path string, line int)

+ func (ddt UnknownComposingDeviceTypeRequirementClusterError) Type() ErrorType

+ type UnknownComposingDeviceTypeRequirementDeviceTypeError struct

+ Requirement *matter.DeviceTypeRequirement

+ func (ddt UnknownComposingDeviceTypeRequirementDeviceTypeError) Error() string

+ func (ddt UnknownComposingDeviceTypeRequirementDeviceTypeError) Origin() (path string, line int)

+ func (ddt UnknownComposingDeviceTypeRequirementDeviceTypeError) Type() ErrorType

+ type UnknownComposingElementRequirementClusterError struct

+ Requirement *matter.DeviceTypeElementRequirement

+ func (ddt UnknownComposingElementRequirementClusterError) Error() string

+ func (ddt UnknownComposingElementRequirementClusterError) Origin() (path string, line int)

+ func (ddt UnknownComposingElementRequirementClusterError) Type() ErrorType

+ type UnknownConformanceIdentifierError struct

+ Entity types.Entity

+ Identifier string

+ func (cf UnknownConformanceIdentifierError) Origin() (path string, line int)

+ func (cf UnknownConformanceIdentifierError) Type() ErrorType

+ func (ddt UnknownConformanceIdentifierError) Error() string

+ type UnknownConformanceReferenceError struct

+ Entity types.Entity

+ Reference string

+ func (cf UnknownConformanceReferenceError) Origin() (path string, line int)

+ func (cf UnknownConformanceReferenceError) Type() ErrorType

+ func (ddt UnknownConformanceReferenceError) Error() string

+ type UnknownConstraintIdentifierError struct

+ Identifier *constraint.IdentifierLimit

+ Source log.Source

+ func (ddt UnknownConstraintIdentifierError) Error() string

+ func (ddt UnknownConstraintIdentifierError) Origin() (path string, line int)

+ func (ddt UnknownConstraintIdentifierError) Type() ErrorType

+ type UnknownConstraintReferenceError struct

+ Reference *constraint.ReferenceLimit

+ Source log.Source

+ func (ddt UnknownConstraintReferenceError) Error() string

+ func (ddt UnknownConstraintReferenceError) Origin() (path string, line int)

+ func (ddt UnknownConstraintReferenceError) Type() ErrorType

+ type UnknownCustomDataTypeError struct

+ DataType *types.DataType

+ Field *matter.Field

+ func (ddt UnknownCustomDataTypeError) Error() string

+ func (ddt UnknownCustomDataTypeError) Origin() (path string, line int)

+ func (ddt UnknownCustomDataTypeError) Type() ErrorType

+ type UnknownElementRequirementClusterError struct

+ Requirement *matter.ElementRequirement

+ func (ddt UnknownElementRequirementClusterError) Error() string

+ func (ddt UnknownElementRequirementClusterError) Origin() (path string, line int)

+ func (ddt UnknownElementRequirementClusterError) Type() ErrorType

+ type UnknownSupersetError struct

+ DeviceType *matter.DeviceType

+ func (ddt UnknownSupersetError) Error() string

+ func (ddt UnknownSupersetError) Origin() (path string, line int)

+ func (ddt UnknownSupersetError) Type() ErrorType

+ type UnreferencedComposingDeviceTypeClusterRequirementDeviceTypeError struct

+ Requirement *matter.DeviceTypeClusterRequirement

+ func (ddt UnreferencedComposingDeviceTypeClusterRequirementDeviceTypeError) Error() string

+ func (ddt UnreferencedComposingDeviceTypeClusterRequirementDeviceTypeError) Origin() (path string, line int)

+ func (ddt UnreferencedComposingDeviceTypeClusterRequirementDeviceTypeError) Type() ErrorType

+ type UnreferencedComposingDeviceTypeElementRequirementDeviceTypeError struct

+ Requirement *matter.DeviceTypeElementRequirement

+ func (ddt UnreferencedComposingDeviceTypeElementRequirementDeviceTypeError) Error() string

+ func (ddt UnreferencedComposingDeviceTypeElementRequirementDeviceTypeError) Origin() (path string, line int)

+ func (ddt UnreferencedComposingDeviceTypeElementRequirementDeviceTypeError) Type() ErrorType