spec

package
v1.5.49 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 24, 2025 License: Apache-2.0 Imports: 31 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ErrNoTableFound = fmt.Errorf("no table found")
View Source 
var ErrNotEnoughRowsInTable = fmt.Errorf("not enough value rows in table")

Functions

func AccessToASCIIDocString 

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

func AssignSectionNames added in v1.5.46 

func AssignSectionNames(doc *Doc) error

func AssignSectionTypes 

func AssignSectionTypes(doc *Doc, top *asciidoc.Section) error

func Build added in v1.5.42 

func Build(cxt context.Context, parserOptions ParserOptions, processingOptions pipeline.ProcessingOptions, builderOptions []BuilderOption, docGroups DocGroupSet, attributes []asciidoc.AttributeName) (specification *Specification, specDocs DocSet, err error)

func BuildDocumentGroups added in v1.5.42 

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

func CanonicalName 

func CanonicalName(name string) string

func DeriveSpecPathFromPaths 

func DeriveSpecPathFromPaths(paths []string) string

func FindFirstTable 

func FindFirstTable(reader asciidoc.Reader, section *asciidoc.Section) *asciidoc.Table

func FindSectionByType 

func FindSectionByType(doc *Doc, top *asciidoc.Section, sectionType matter.Section) *asciidoc.Section

func GetDataType added in v1.5.41 

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

func NewPreparseContext 

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

func NewSource 

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

func NewSpecPath 

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

func Parse 

func Parse(cxt context.Context, parserOptions ParserOptions, processingOptions pipeline.ProcessingOptions, builderOptions []BuilderOption, attributes []asciidoc.AttributeName) (specification *Specification, specDocs DocSet, err error)

func ParseAccess 

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

func ParseCommandDirection 

func ParseCommandDirection(s string) matter.Interface

func PatchSpecForSdk 

func PatchSpecForSdk(spec *Specification) error

PatchSpecForSdk is a grab bag of oddities in the spec that need to be corrected for use in the SDK

func PreParse added in v1.5.42 

func PreParse(cxt context.Context, parserOptions ParserOptions, processingOptions pipeline.ProcessingOptions, docGroups DocGroupSet, attributes []asciidoc.AttributeName) (err error)

func ReferenceName 

func ReferenceName(reader asciidoc.Reader, element any) string

func RenderTableCell 

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

func Targeter 

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

func Validate 

func Validate(spec *Specification)

Types

type Anchor 

type Anchor struct {
	Document      *Doc
	Source        matter.Source
	ID            asciidoc.Elements
	LabelElements asciidoc.Elements
	Element       asciidoc.Element
	Parent        asciidoc.Parent
}

func NewAnchor 

func NewAnchor(doc *Doc, id asciidoc.Elements, element asciidoc.Element, parent asciidoc.Parent, label ...asciidoc.Element) *Anchor

func (*Anchor) Identifier added in v1.5.41 

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

func (*Anchor) Name 

func (a *Anchor) Name(reader asciidoc.Reader) string

func (*Anchor) SyncToDoc 

func (a *Anchor) SyncToDoc(id asciidoc.Elements)

type Builder 

type Builder struct {
	Spec *Specification
	// contains filtered or unexported fields
}

func NewBuilder 

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

func (Builder) Name 

func (sp Builder) Name() string

func (*Builder) Process 

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

type BuilderOption 

type BuilderOption func(tg *Builder)

func IgnoreHierarchy 

func IgnoreHierarchy(ignore bool) BuilderOption

type BuilderOptions 

type BuilderOptions struct {
	IgnoreHierarchy bool `default:"false" help:"ignore hierarchy" group:"Spec:"`
}

func (BuilderOptions) List added in v1.5.41 

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

type CellRenderer 

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

type ClusterReferenceNameMismatch 

type ClusterReferenceNameMismatch struct {
	Cluster *matter.Cluster
	Name    string
	Source  log.Source
}

func (ClusterReferenceNameMismatch) Error 

func (ddt ClusterReferenceNameMismatch) Error() string

func (ClusterReferenceNameMismatch) Origin 

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

func (ClusterReferenceNameMismatch) Type 

func (ddt ClusterReferenceNameMismatch) Type() ErrorType

type ColumnIndex 

type ColumnIndex map[matter.TableColumn]int

func (ColumnIndex) HasAll 

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

func (ColumnIndex) HasAny 

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

type CrossReference 

type CrossReference struct {
	Document  *Doc
	Reference *asciidoc.CrossReference
	Parent    asciidoc.Parent
	Source    matter.Source
}

func (*CrossReference) Identifier added in v1.5.41 

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

func (*CrossReference) SyncToDoc 

func (cr *CrossReference) SyncToDoc(id asciidoc.Elements)

type DeviceTypeReferenceNameMismatch 

type DeviceTypeReferenceNameMismatch struct {
	DeviceType *matter.DeviceType
	Name       string
	Source     log.Source
}

func (DeviceTypeReferenceNameMismatch) Error 

func (ddt DeviceTypeReferenceNameMismatch) Error() string

func (DeviceTypeReferenceNameMismatch) Origin 

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

func (DeviceTypeReferenceNameMismatch) Type 

func (ddt DeviceTypeReferenceNameMismatch) Type() ErrorType

type DeviceTypeSet 

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

type Doc 

type Doc struct {
	Path asciidoc.Path

	Base *asciidoc.Document

	Domain matter.Domain
	// contains filtered or unexported fields
}

func ParseFile added in v1.5.41 

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

func ReadFile 

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

func (*Doc) Anchors 

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

func (*Doc) Append added in v1.5.41 

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

func (*Doc) Children added in v1.5.41 

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

func (*Doc) CrossReferences 

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

func (*Doc) DocType 

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

func (*Doc) Entities 

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

func (*Doc) EntitiesForSection 

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

func (*Doc) Equals 

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

func (*Doc) Errata 

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

func (*Doc) FindAnchor 

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

func (*Doc) FindAnchorByID added in v1.5.41 

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

func (*Doc) FindAnchors 

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

func (*Doc) Footnotes 

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

func (*Doc) GetHeaderCellString 

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

func (*Doc) GlobalObjects 

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

func (*Doc) Group 

func (doc *Doc) Group() *DocGroup

func (*Doc) OrderedEntities 

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

func (*Doc) Parents 

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

func (*Doc) Reader added in v1.5.41 

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

func (*Doc) SectionName added in v1.5.41 

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

func (*Doc) SectionType added in v1.5.41 

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

func (*Doc) SetChildren added in v1.5.41 

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

func (*Doc) SetSectionName added in v1.5.41 

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

func (*Doc) SetSectionType added in v1.5.41 

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

func (*Doc) Type 

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

type DocGroup 

type DocGroup struct {
	Root *Doc

	Docs []*Doc

	Reader asciidoc.Reader
	// contains filtered or unexported fields
}

func NewDocGroup 

func NewDocGroup(root *Doc) *DocGroup

func (*DocGroup) Anchors 

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

func (*DocGroup) CrossReferences 

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

type DocGroupSet added in v1.5.42 

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

type DocSet 

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

func NewDocSet 

func NewDocSet() DocSet

type DocumentGrouper added in v1.5.41 

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

func NewDocumentGrouper added in v1.5.41 

func NewDocumentGrouper(specRoot string) *DocumentGrouper

func (DocumentGrouper) Name added in v1.5.41 

func (dg DocumentGrouper) Name() string

func (*DocumentGrouper) Process added in v1.5.41 

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

type DuplicateEntityIDError 

type DuplicateEntityIDError struct {
	Entity   types.Entity
	Previous types.Entity
}

func (DuplicateEntityIDError) Error 

func (ddt DuplicateEntityIDError) Error() string

func (DuplicateEntityIDError) Origin 

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

func (DuplicateEntityIDError) Type 

func (ddt DuplicateEntityIDError) Type() ErrorType

type DuplicateEntityNameError 

type DuplicateEntityNameError struct {
	Entity   types.Entity
	Previous types.Entity
}

func (DuplicateEntityNameError) Error 

func (ddt DuplicateEntityNameError) Error() string

func (DuplicateEntityNameError) Origin 

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

func (DuplicateEntityNameError) Type 

func (ddt DuplicateEntityNameError) Type() ErrorType

type ElementRequirementUnknownElementError 

type ElementRequirementUnknownElementError struct {
	Requirement *matter.ElementRequirement
}

func (ElementRequirementUnknownElementError) Error 

func (ddt ElementRequirementUnknownElementError) Error() string

func (ElementRequirementUnknownElementError) Origin 

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

func (ElementRequirementUnknownElementError) Type 

func (ddt ElementRequirementUnknownElementError) Type() ErrorType

type ElementRequirementUnreferencedClusterError 

type ElementRequirementUnreferencedClusterError struct {
	Requirement *matter.ElementRequirement
}

func (ElementRequirementUnreferencedClusterError) Error 

func (ddt ElementRequirementUnreferencedClusterError) Error() string

func (ElementRequirementUnreferencedClusterError) Origin 

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

func (ElementRequirementUnreferencedClusterError) Type 

func (ddt ElementRequirementUnreferencedClusterError) Type() ErrorType

type EntityRefs 

type EntityRefs[T comparable] struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewEntityRefs 

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

func (*EntityRefs[T]) Add 

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

func (*EntityRefs[T]) Get 

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

type Error 

type Error interface {
	Type() ErrorType
	Error() string
	log.Source
}

type ErrorType 

type ErrorType uint16
const (
	ErrorTypeUnknown ErrorType = iota
	ErrorTypeGenericParse
	ErrorTypeDuplicateEntityID
	ErrorTypeDuplicateEntityName
	ErrorTypeUnknownConstraintIdentifier
	ErrorTypeUnknownConstraintReference
	ErrorTypeUnknownCustomDataType
	ErrorTypeUnknownSuperset
	ErrorTypeUnknownClusterRequirement
	ErrorTypeUnknownElementRequirementCluster
	ErrorTypeElementRequirementUnreferencedCluster
	ErrorTypeElementRequirementUnknownElement
	ErrorTypeComposingDeviceTypeRequirementUnknownDeviceType
	ErrorTypeComposingDeviceTypeClusterRequirementUnknownCluster
	ErrorTypeComposingDeviceTypeClusterRequirementUnknownDeviceType
	ErrorTypeComposingDeviceTypeClusterRequirementUnreferencedDeviceType
	ErrorTypeComposingDeviceTypeElementRequirementUnknownCluster
	ErrorTypeComposingDeviceTypeElementRequirementUnknownDeviceType
	ErrorTypeComposingDeviceTypeElementRequirementUnreferencedDeviceType
	ErrorTypeConditionRequirementUnknownDeviceType
	ErrorTypeConditionRequirementUnreferencedDeviceType
	ErrorTypeConditionRequirementUnknownCondition
	ErrorTypeTagRequirementUnreferencedDeviceType
	ErrorTypeTagRequirementUnknownNamespace
	ErrorTypeTagRequirementNamespaceNameMismatch
	ErrorTypeTagRequirementUnknownTag
	ErrorTypeTagRequirementTagNameMismatch
	ErrorTypeClusterReferenceNameMismatch
	ErrorTypeDeviceTypeReferenceNameMismatch
	ErrorTypeNamespaceNameMismatch
	ErrorTypeUnknownBaseCluster
	ErrorTypeUnknownConformanceIdentifier
	ErrorTypeUnknownConformanceReference
	ErrorTypeFabricScopingNotAllowed
	ErrorTypeFabricSensitivityNotAllowed
	ErrorTypeFabricScopedStructNotAllowed
	ErrorTypeInvalidConformance
	ErrorTypeInvalidConstraint
	ErrorTypeInvalidFallback
)

type ExtraColumn 

type ExtraColumn struct {
	Name   string
	Offset int
}

type FabricScopedStructNotAllowedError 

type FabricScopedStructNotAllowedError struct {
	Entity types.Entity
}

func (FabricScopedStructNotAllowedError) Error 

func (ddt FabricScopedStructNotAllowedError) Error() string

func (FabricScopedStructNotAllowedError) Origin 

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

func (FabricScopedStructNotAllowedError) Type 

func (cf FabricScopedStructNotAllowedError) Type() ErrorType

type FabricScopingNotAllowedError 

type FabricScopingNotAllowedError struct {
	Entity types.Entity
}

func (FabricScopingNotAllowedError) Error 

func (ddt FabricScopingNotAllowedError) Error() string

func (FabricScopingNotAllowedError) Origin 

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

func (FabricScopingNotAllowedError) Type 

func (cf FabricScopingNotAllowedError) Type() ErrorType

type FabricSensitivityNotAllowedError 

type FabricSensitivityNotAllowedError struct {
	Entity types.Entity
}

func (FabricSensitivityNotAllowedError) Error 

func (ddt FabricSensitivityNotAllowedError) Error() string

func (FabricSensitivityNotAllowedError) Origin 

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

func (FabricSensitivityNotAllowedError) Type 

func (cf FabricSensitivityNotAllowedError) Type() ErrorType

type FilterOptions 

type FilterOptions struct {
	Paths         []string `arg:"" optional:"" help:"Paths of AsciiDoc files to use for generation" group:"Spec:"`
	Exclude       []string `short:"e"  help:"exclude files matching this file pattern" group:"Spec:"`
	Force         bool     `default:"false" help:"generate files even if there were spec parsing errors" group:"Spec:"`
	IgnoreErrored bool     `default:"false" help:"ignore any spec files with parsing errors" group:"Spec:"`
}

type GenericParseError added in v1.5.39 

type GenericParseError struct {
	Source log.Source
	// contains filtered or unexported fields
}

func (GenericParseError) Origin added in v1.5.39 

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

func (GenericParseError) Type added in v1.5.39 

func (gpe GenericParseError) Type() ErrorType

type InvalidConformanceError 

type InvalidConformanceError struct {
	Conformance string
	Source      log.Source
}

func (InvalidConformanceError) Error 

func (ddt InvalidConformanceError) Error() string

func (InvalidConformanceError) Origin 

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

func (InvalidConformanceError) Type 

func (cf InvalidConformanceError) Type() ErrorType

type InvalidConstraintError 

type InvalidConstraintError struct {
	Constraint string
	Source     log.Source
}

func (InvalidConstraintError) Error 

func (ddt InvalidConstraintError) Error() string

func (InvalidConstraintError) Origin 

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

func (InvalidConstraintError) Type 

func (cf InvalidConstraintError) Type() ErrorType

type InvalidFallbackError 

type InvalidFallbackError struct {
	Fallback string
	Source   log.Source
}

func (InvalidFallbackError) Error 

func (ddt InvalidFallbackError) Error() string

func (InvalidFallbackError) Origin 

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

func (InvalidFallbackError) Type 

func (cf InvalidFallbackError) Type() ErrorType

type NamespaceNameMismatchTagRequirementError added in v1.5.46 

type NamespaceNameMismatchTagRequirementError struct {
	Requirement *matter.TagRequirement
	Namespace   *matter.Namespace
}

func (NamespaceNameMismatchTagRequirementError) Error added in v1.5.46 

func (ddt NamespaceNameMismatchTagRequirementError) Error() string

func (NamespaceNameMismatchTagRequirementError) Origin added in v1.5.46 

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

func (NamespaceNameMismatchTagRequirementError) Type added in v1.5.46 

func (ddt NamespaceNameMismatchTagRequirementError) Type() ErrorType

type ParseErrors 

type ParseErrors struct {
	Errors []Error
}

func (ParseErrors) Error 

func (pe ParseErrors) Error() string

type Parser 

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

func NewParser 

func NewParser(parserOptions ParserOptions) (Parser, error)

func (Parser) Name 

func (p Parser) Name() string

func (Parser) Process 

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 (Parser) Targets 

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

type ParserOptions 

type ParserOptions struct {
	Root string `` /* 159-byte string literal not displayed */
}

func (*ParserOptions) AfterApply 

func (po *ParserOptions) AfterApply() error

type PreParseReader added in v1.5.41 

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

func (*PreParseReader) Count added in v1.5.41 

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

func (*PreParseReader) Iterate added in v1.5.41 

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

type PreParser added in v1.5.41 

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

func NewPreParser added in v1.5.41 

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

func (PreParser) Name added in v1.5.41 

func (r PreParser) Name() string

func (PreParser) Process added in v1.5.41 

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

type Reader 

type Reader struct {
	Root string
	// contains filtered or unexported fields
}

func NewReader 

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

func (Reader) Name 

func (r Reader) Name() string

func (Reader) Process 

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 Specification 

type Specification struct {
	Root string

	Clusters       map[*matter.Cluster]struct{}
	ClustersByID   map[uint64]*matter.Cluster
	ClustersByName map[string]*matter.Cluster

	DeviceTypes       []*matter.DeviceType
	DeviceTypesByID   map[uint64]*matter.DeviceType
	DeviceTypesByName map[string]*matter.DeviceType

	BaseDeviceType     *matter.DeviceType
	RootNodeDeviceType *matter.DeviceType

	Namespaces []*matter.Namespace

	ClusterRefs  EntityRefs[*matter.Cluster]
	DataTypeRefs EntityRefs[types.Entity]
	DocRefs      map[types.Entity]*Doc

	GlobalObjects types.EntitySet[*Doc]

	Docs      map[string]*Doc
	DocGroups []*DocGroup

	Errors []Error
	// contains filtered or unexported fields
}

func (*Specification) BuildClusterReferences 

func (spec *Specification) BuildClusterReferences()

func (*Specification) BuildDataTypeReferences 

func (spec *Specification) BuildDataTypeReferences()

func (*Specification) ComposeDeviceType 

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

type StringReader 

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

func NewStringReader 

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

func (StringReader) Name 

func (r StringReader) Name() string

func (StringReader) Process 

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 

type TableInfo struct {
	Doc            *Doc
	Element        *asciidoc.Table
	Rows           []*asciidoc.TableRow
	HeaderRowIndex int
	ColumnMap      ColumnIndex
	ExtraColumns   []ExtraColumn
}

func ReadTable 

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

func (*TableInfo) Body 

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

func (*TableInfo) ColumnIndex 

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

func (*TableInfo) ContentRows added in v1.5.39 

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

func (*TableInfo) ReadConformance 

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

func (*TableInfo) ReadConstraint 

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

func (*TableInfo) ReadDataType 

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

func (*TableInfo) ReadFallback 

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

func (*TableInfo) ReadID 

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

func (*TableInfo) ReadLocation 

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

func (*TableInfo) ReadName 

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

func (*TableInfo) ReadNameAtOffset added in v1.5.41 

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

func (*TableInfo) ReadQuality 

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

func (*TableInfo) ReadString 

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

func (*TableInfo) ReadStringAtOffset 

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

func (*TableInfo) ReadValue 

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

func (*TableInfo) ReadValueByIndex 

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

func (*TableInfo) RenderColumn 

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

func (*TableInfo) Rescan 

func (ti *TableInfo) Rescan(doc *Doc, reader asciidoc.Reader) (err error)

type TagNameMismatchTagRequirementError added in v1.5.46 

type TagNameMismatchTagRequirementError struct {
	Requirement *matter.TagRequirement
	SemanticTag *matter.SemanticTag
}

func (TagNameMismatchTagRequirementError) Error added in v1.5.46 

func (ddt TagNameMismatchTagRequirementError) Error() string

func (TagNameMismatchTagRequirementError) Origin added in v1.5.46 

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

func (TagNameMismatchTagRequirementError) Type added in v1.5.46 

func (ddt TagNameMismatchTagRequirementError) Type() ErrorType

type UnknownBaseClusterError 

type UnknownBaseClusterError struct {
	Cluster *matter.Cluster
}

func (UnknownBaseClusterError) Error 

func (ddt UnknownBaseClusterError) Error() string

func (UnknownBaseClusterError) Origin 

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

func (UnknownBaseClusterError) Type 

func (ddt UnknownBaseClusterError) Type() ErrorType

type UnknownClusterRequirementError 

type UnknownClusterRequirementError struct {
	Requirement *matter.ClusterRequirement
}

func (UnknownClusterRequirementError) Error 

func (ddt UnknownClusterRequirementError) Error() string

func (UnknownClusterRequirementError) Origin 

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

func (UnknownClusterRequirementError) Type 

func (ddt UnknownClusterRequirementError) Type() ErrorType

type UnknownComposingDeviceTypeClusterRequirementDeviceTypeError 

type UnknownComposingDeviceTypeClusterRequirementDeviceTypeError struct {
	Requirement *matter.DeviceTypeClusterRequirement
}

func (UnknownComposingDeviceTypeClusterRequirementDeviceTypeError) Error 

func (ddt UnknownComposingDeviceTypeClusterRequirementDeviceTypeError) Error() string

func (UnknownComposingDeviceTypeClusterRequirementDeviceTypeError) Origin 

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

func (UnknownComposingDeviceTypeClusterRequirementDeviceTypeError) Type 

func (ddt UnknownComposingDeviceTypeClusterRequirementDeviceTypeError) Type() ErrorType

type UnknownComposingDeviceTypeElementRequirementDeviceTypeError 

type UnknownComposingDeviceTypeElementRequirementDeviceTypeError struct {
	Requirement *matter.DeviceTypeElementRequirement
}

func (UnknownComposingDeviceTypeElementRequirementDeviceTypeError) Error 

func (ddt UnknownComposingDeviceTypeElementRequirementDeviceTypeError) Error() string

func (UnknownComposingDeviceTypeElementRequirementDeviceTypeError) Origin 

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

func (UnknownComposingDeviceTypeElementRequirementDeviceTypeError) Type 

func (ddt UnknownComposingDeviceTypeElementRequirementDeviceTypeError) Type() ErrorType

type UnknownComposingDeviceTypeRequirementClusterError 

type UnknownComposingDeviceTypeRequirementClusterError struct {
	Requirement *matter.DeviceTypeClusterRequirement
}

func (UnknownComposingDeviceTypeRequirementClusterError) Error 

func (ddt UnknownComposingDeviceTypeRequirementClusterError) Error() string

func (UnknownComposingDeviceTypeRequirementClusterError) Origin 

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

func (UnknownComposingDeviceTypeRequirementClusterError) Type 

func (ddt UnknownComposingDeviceTypeRequirementClusterError) Type() ErrorType

type UnknownComposingDeviceTypeRequirementDeviceTypeError 

type UnknownComposingDeviceTypeRequirementDeviceTypeError struct {
	Requirement *matter.DeviceTypeRequirement
}

func (UnknownComposingDeviceTypeRequirementDeviceTypeError) Error 

func (ddt UnknownComposingDeviceTypeRequirementDeviceTypeError) Error() string

func (UnknownComposingDeviceTypeRequirementDeviceTypeError) Origin 

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

func (UnknownComposingDeviceTypeRequirementDeviceTypeError) Type 

func (ddt UnknownComposingDeviceTypeRequirementDeviceTypeError) Type() ErrorType

type UnknownComposingDeviceTypeTagRequirementDeviceTypeError added in v1.5.46 

type UnknownComposingDeviceTypeTagRequirementDeviceTypeError struct {
	Requirement *matter.DeviceTypeTagRequirement
}

func (UnknownComposingDeviceTypeTagRequirementDeviceTypeError) Error added in v1.5.46 

func (ddt UnknownComposingDeviceTypeTagRequirementDeviceTypeError) Error() string

func (UnknownComposingDeviceTypeTagRequirementDeviceTypeError) Origin added in v1.5.46 

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

func (UnknownComposingDeviceTypeTagRequirementDeviceTypeError) Type added in v1.5.46 

func (ddt UnknownComposingDeviceTypeTagRequirementDeviceTypeError) Type() ErrorType

type UnknownComposingElementRequirementClusterError 

type UnknownComposingElementRequirementClusterError struct {
	Requirement *matter.DeviceTypeElementRequirement
}

func (UnknownComposingElementRequirementClusterError) Error 

func (ddt UnknownComposingElementRequirementClusterError) Error() string

func (UnknownComposingElementRequirementClusterError) Origin 

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

func (UnknownComposingElementRequirementClusterError) Type 

func (ddt UnknownComposingElementRequirementClusterError) Type() ErrorType

type UnknownConditionRequirementConditionError added in v1.5.39 

type UnknownConditionRequirementConditionError struct {
	Requirement *matter.ConditionRequirement
}

func (UnknownConditionRequirementConditionError) Error added in v1.5.39 

func (ddt UnknownConditionRequirementConditionError) Error() string

func (UnknownConditionRequirementConditionError) Origin added in v1.5.39 

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

func (UnknownConditionRequirementConditionError) Type added in v1.5.39 

func (ddt UnknownConditionRequirementConditionError) Type() ErrorType

type UnknownConditionRequirementDeviceTypeError added in v1.5.39 

type UnknownConditionRequirementDeviceTypeError struct {
	Requirement *matter.ConditionRequirement
}

func (UnknownConditionRequirementDeviceTypeError) Error added in v1.5.39 

func (ddt UnknownConditionRequirementDeviceTypeError) Error() string

func (UnknownConditionRequirementDeviceTypeError) Origin added in v1.5.39 

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

func (UnknownConditionRequirementDeviceTypeError) Type added in v1.5.39 

func (ddt UnknownConditionRequirementDeviceTypeError) Type() ErrorType

type UnknownConformanceIdentifierError 

type UnknownConformanceIdentifierError struct {
	Entity     types.Entity
	Identifier string
}

func (UnknownConformanceIdentifierError) Error 

func (ddt UnknownConformanceIdentifierError) Error() string

func (UnknownConformanceIdentifierError) Origin 

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

func (UnknownConformanceIdentifierError) Type 

func (cf UnknownConformanceIdentifierError) Type() ErrorType

type UnknownConformanceReferenceError 

type UnknownConformanceReferenceError struct {
	Entity    types.Entity
	Reference string
}

func (UnknownConformanceReferenceError) Error 

func (ddt UnknownConformanceReferenceError) Error() string

func (UnknownConformanceReferenceError) Origin 

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

func (UnknownConformanceReferenceError) Type 

func (cf UnknownConformanceReferenceError) Type() ErrorType

type UnknownConstraintIdentifierError 

type UnknownConstraintIdentifierError struct {
	Identifier *constraint.IdentifierLimit
	Source     log.Source
}

func (UnknownConstraintIdentifierError) Error 

func (ddt UnknownConstraintIdentifierError) Error() string

func (UnknownConstraintIdentifierError) Origin 

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

func (UnknownConstraintIdentifierError) Type 

func (ddt UnknownConstraintIdentifierError) Type() ErrorType

type UnknownConstraintReferenceError 

type UnknownConstraintReferenceError struct {
	Reference *constraint.ReferenceLimit
	Source    log.Source
}

func (UnknownConstraintReferenceError) Error 

func (ddt UnknownConstraintReferenceError) Error() string

func (UnknownConstraintReferenceError) Origin 

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

func (UnknownConstraintReferenceError) Type 

func (ddt UnknownConstraintReferenceError) Type() ErrorType

type UnknownCustomDataTypeError 

type UnknownCustomDataTypeError struct {
	Field    *matter.Field
	DataType *types.DataType
}

func (UnknownCustomDataTypeError) Error 

func (ddt UnknownCustomDataTypeError) Error() string

func (UnknownCustomDataTypeError) Origin 

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

func (UnknownCustomDataTypeError) Type 

func (ddt UnknownCustomDataTypeError) Type() ErrorType

type UnknownElementRequirementClusterError 

type UnknownElementRequirementClusterError struct {
	Requirement *matter.ElementRequirement
}

func (UnknownElementRequirementClusterError) Error 

func (ddt UnknownElementRequirementClusterError) Error() string

func (UnknownElementRequirementClusterError) Origin 

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

func (UnknownElementRequirementClusterError) Type 

func (ddt UnknownElementRequirementClusterError) Type() ErrorType

type UnknownNamespaceTagRequirementError added in v1.5.46 

type UnknownNamespaceTagRequirementError struct {
	Requirement *matter.TagRequirement
}

func (UnknownNamespaceTagRequirementError) Error added in v1.5.46 

func (ddt UnknownNamespaceTagRequirementError) Error() string

func (UnknownNamespaceTagRequirementError) Origin added in v1.5.46 

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

func (UnknownNamespaceTagRequirementError) Type added in v1.5.46 

func (ddt UnknownNamespaceTagRequirementError) Type() ErrorType

type UnknownSupersetError 

type UnknownSupersetError struct {
	DeviceType *matter.DeviceType
}

func (UnknownSupersetError) Error 

func (ddt UnknownSupersetError) Error() string

func (UnknownSupersetError) Origin 

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

func (UnknownSupersetError) Type 

func (ddt UnknownSupersetError) Type() ErrorType

type UnknownTagRequirementError added in v1.5.46 

type UnknownTagRequirementError struct {
	Requirement *matter.TagRequirement
}

func (UnknownTagRequirementError) Error added in v1.5.46 

func (ddt UnknownTagRequirementError) Error() string

func (UnknownTagRequirementError) Origin added in v1.5.46 

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

func (UnknownTagRequirementError) Type added in v1.5.46 

func (ddt UnknownTagRequirementError) Type() ErrorType

type UnreferencedComposingDeviceTypeClusterRequirementDeviceTypeError 

type UnreferencedComposingDeviceTypeClusterRequirementDeviceTypeError struct {
	Requirement *matter.DeviceTypeClusterRequirement
}

func (UnreferencedComposingDeviceTypeClusterRequirementDeviceTypeError) Error 

func (ddt UnreferencedComposingDeviceTypeClusterRequirementDeviceTypeError) Error() string

func (UnreferencedComposingDeviceTypeClusterRequirementDeviceTypeError) Origin 

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

func (UnreferencedComposingDeviceTypeClusterRequirementDeviceTypeError) Type 

func (ddt UnreferencedComposingDeviceTypeClusterRequirementDeviceTypeError) Type() ErrorType

type UnreferencedComposingDeviceTypeElementRequirementDeviceTypeError 

type UnreferencedComposingDeviceTypeElementRequirementDeviceTypeError struct {
	Requirement *matter.DeviceTypeElementRequirement
}

func (UnreferencedComposingDeviceTypeElementRequirementDeviceTypeError) Error 

func (ddt UnreferencedComposingDeviceTypeElementRequirementDeviceTypeError) Error() string

func (UnreferencedComposingDeviceTypeElementRequirementDeviceTypeError) Origin 

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

func (UnreferencedComposingDeviceTypeElementRequirementDeviceTypeError) Type 

func (ddt UnreferencedComposingDeviceTypeElementRequirementDeviceTypeError) Type() ErrorType

type UnreferencedConditionRequirementDeviceTypeError added in v1.5.39 

type UnreferencedConditionRequirementDeviceTypeError struct {
	Requirement *matter.ConditionRequirement
}

func (UnreferencedConditionRequirementDeviceTypeError) Error added in v1.5.39 

func (ddt UnreferencedConditionRequirementDeviceTypeError) Error() string

func (UnreferencedConditionRequirementDeviceTypeError) Origin added in v1.5.39 

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

func (UnreferencedConditionRequirementDeviceTypeError) Type added in v1.5.39 

func (ddt UnreferencedConditionRequirementDeviceTypeError) Type() ErrorType

type UnreferencedTagRequirementDeviceTypeError added in v1.5.45 

type UnreferencedTagRequirementDeviceTypeError struct {
	Requirement *matter.DeviceTypeTagRequirement
}

func (UnreferencedTagRequirementDeviceTypeError) Error added in v1.5.45 

func (ddt UnreferencedTagRequirementDeviceTypeError) Error() string

func (UnreferencedTagRequirementDeviceTypeError) Origin added in v1.5.45 

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

func (UnreferencedTagRequirementDeviceTypeError) Type added in v1.5.45 

func (ddt UnreferencedTagRequirementDeviceTypeError) Type() ErrorType

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.