spec

type Any ¶ added in v0.24.0

type Any []Marshaler

Any is an extension point containing <any> information.

func (e Any) Marshal3MF(x Encoder, start *xml.StartElement) error

type AnyAttr ¶ added in v0.24.0

type AnyAttr []AttrGroup

func (a AnyAttr) Get(namespace string) AttrGroup

func (a AnyAttr) Marshal3MF(x Encoder, start *xml.StartElement) error

type AppendTokenElementDecoder ¶ added in v0.23.0

type AppendTokenElementDecoder interface {
	ElementDecoder
	AppendToken(xml.Token)
}

AppendTokenElementDecoder must be implemented by element decoders that need to accumulate tokens to support loseless encoding.

type AttrGroup ¶ added in v0.24.0

type AttrGroup interface {
	UnmarshalerAttr
	Marshaler
	Namespace() string
}

AttrGroup defines a container for different attributes of the same namespace. It supports encoding and decoding to XML.

func NewAttrGroup(namespace string, parent xml.Name) AttrGroup

type CharDataElementDecoder ¶

type CharDataElementDecoder interface {
	ElementDecoder
	CharData([]byte)
}

CharDataElementDecoder must be implemented by element decoders that need to decode raw text.

type ChildElementDecoder ¶

type ChildElementDecoder interface {
	ElementDecoder
	Child(xml.Name) (int, ElementDecoder)
}

ChildElementDecoder must be implemented by element decoders that need decoding nested elements.

type ElementDecoder ¶

type ElementDecoder interface {
	Start([]XMLAttr) error
	End()
}

ElementDecoder defines the minimum contract to decode a 3MF node.

type Encoder ¶

type Encoder interface {
	AddRelationship(Relationship)
	FloatPresicion() int
	EncodeToken(xml.Token)
	Flush() error
	SetAutoClose(bool)
	// Use SetSkipAttrEscape(true) when there is no need to escape
	// StartElement attribute values, such as as when all attributes
	// are filled using strconv.
	SetSkipAttrEscape(bool)
}

Encoder provides de necessary methods to encode specs. It should not be implemented by spec authors but will be provided be go3mf itself.

type GetterElementDecoder ¶ added in v0.24.0

type GetterElementDecoder interface {
	ElementDecoder
	Element() interface{}
}

func NewElementDecoder(name xml.Name) GetterElementDecoder

type Marshaler ¶

type Marshaler interface {
	Marshal3MF(Encoder, *xml.StartElement) error
}

Marshaler is the interface implemented by objects that can marshal themselves into valid XML elements.

type PropertyGroup ¶

type PropertyGroup interface {
	Len() int
}

type Relationship ¶

type Relationship struct {
	Path string
	Type string
	ID   string
}

type Spec ¶

type Spec interface {
	NewAttrGroup(parent xml.Name) AttrGroup
	NewElementDecoder(name xml.Name) GetterElementDecoder
}

Spec is the interface that must be implemented by a 3mf spec.

Specs may implement ValidateSpec.

func Load(space string) (Spec, bool)

type UnknownAttrs ¶ added in v0.23.0

type UnknownAttrs struct {
	Space string
	Attr  []xml.Attr
}

An UnknownAttrs represents a list of attributes that are not supported by any loaded Spec.

func (u UnknownAttrs) Marshal3MF(enc Encoder, start *xml.StartElement) error

func (u UnknownAttrs) Namespace() string

func (u *UnknownAttrs) Unmarshal3MFAttr(a XMLAttr) error

type UnknownTokens ¶ added in v0.23.0

type UnknownTokens struct {
	Token []xml.Token
}

UnknownTokens represents a section of an xml that cannot be decoded by any loaded Spec.

func (u UnknownTokens) Marshal3MF(enc Encoder, _ *xml.StartElement) error

func (u UnknownTokens) XMLName() xml.Name

type UnknownTokensDecoder ¶ added in v0.23.0

type UnknownTokensDecoder struct {
	XMLName xml.Name
	// contains filtered or unexported fields
}

UnknownTokensDecoder can be used by spec decoders to maintain the xml tree elements of unknown extensions.

func NewUnknownDecoder(name xml.Name) *UnknownTokensDecoder

func (d *UnknownTokensDecoder) AppendToken(t xml.Token)

func (d *UnknownTokensDecoder) Element() interface{}

func (d *UnknownTokensDecoder) End()

func (d *UnknownTokensDecoder) Start(attrs []XMLAttr) error

func (d UnknownTokensDecoder) Tokens() UnknownTokens

type UnmarshalerAttr ¶ added in v0.24.0

type UnmarshalerAttr interface {
	Unmarshal3MFAttr(XMLAttr) error
}

UnmarshalerAttr is the interface implemented by objects that can unmarshal an XML element description of themselves.

type ValidateSpec ¶

type ValidateSpec interface {
	Spec
	Validate(model interface{}, path string, element interface{}) error
}

If a Spec implemented ValidateSpec, then model.Validate will call Validate and aggregate the resulting erros.

model is guaranteed to be a *go3mf.Model

func LoadValidator(ns string) (ValidateSpec, bool)

type XMLAttr ¶ added in v0.24.0

type XMLAttr struct {
	Name  xml.Name
	Value []byte
}

An XMLAttr represents an attribute in an XML element (Name=Value).