crossref

Documentation

Index

• type Ref
  • func New(peerName string, class string, target strfmt.UUID) *Ref
  • func NewLocalhost(class string, target strfmt.UUID) *Ref
  • func Parse(uriString string) (*Ref, error)
  • func ParseSingleRef(singleRef *models.SingleRef) (*Ref, error)
  • func (r *Ref) SingleRef() *models.SingleRef
  • func (r *Ref) String() string
• type RefSource
  • func NewSource(className schema.ClassName, property schema.PropertyName, id strfmt.UUID) *RefSource
  • func ParseSource(uriString string) (*RefSource, error)
  • func (r *RefSource) String() string

Types

type Ref

type Ref struct {
	Local    bool        `json:"local"`
	PeerName string      `json:"peerName"`
	TargetID strfmt.UUID `json:"targetID"`
	Class    string      `json:"className"`
}

Ref is an abstraction of the cross-refs which are specified in a URI format in the API. When this type is used it is safe to assume that a Ref is semantically valid. This guarantee would not be possible on the URI format, as the URI can be well-formed, but not contain the data we expect in it. Do not use directly, such as crossref.Ref{}, as you won't have any guarantees in this case. Always use one of the parsing options or New()

func New

func New(peerName string, class string, target strfmt.UUID) *Ref

New is a safe way to generate a Reference, as all required arguments must be set in the constructor fn

func NewLocalhost

func NewLocalhost(class string, target strfmt.UUID) *Ref

func Parse

func Parse(uriString string) (*Ref, error)

Parse is a safe way to generate a Ref, as it will error if any of the input parameters are not as expected.

func ParseSingleRef

func ParseSingleRef(singleRef *models.SingleRef) (*Ref, error)

ParseSingleRef is a safe way to generate a Ref from a models.SingleRef, a helper construct that represents the API structure. It will error if any of the input parameters are not as expected.

func (*Ref) SingleRef

func (r *Ref) SingleRef() *models.SingleRef

SingleRef converts the parsed Ref back into the API helper construct containing a stringified representation (URI format) of the Ref

func (*Ref) String

func (r *Ref) String() string

type RefSource

type RefSource struct {
	Local    bool                `json:"local"`
	PeerName string              `json:"peerName"`
	Property schema.PropertyName `json:"property"`
	Class    schema.ClassName    `json:"class"`
	TargetID strfmt.UUID         `json:"targetID"`
}

RefSource is an abstraction of the source of a cross-ref. The opposite would be Ref which represents the target insted. A RefSource is specified in a URI format in the API. When this type is used it is safe to assume that a Ref is semantically valid. This guarantuee would not be possible on the URI format, as the URI can be well-formed, but not contain the data we expect in it. Do not use directly, such as crossref.RefSource{}, as you won't have any guarantees in this case. Always use one of the parsing options or New()

func NewSource

func NewSource(className schema.ClassName,
	property schema.PropertyName, id strfmt.UUID,
) *RefSource

func ParseSource

func ParseSource(uriString string) (*RefSource, error)

ParseSource is a safe way to generate a RefSource, as it will error if any of the input parameters are not as expected.

func (*RefSource) String

func (r *RefSource) String() string