id

Documentation

Index

• Variables
• func PluginIDsToStrings(ids []PluginID) []string
• type Organization
  • func (Organization) Type() string
• type OrganizationID
• type OrganizationIDList
• type Plugin
  • func (Plugin) Type() string
• type PluginID
  • func MustPluginID(id string) PluginID
  • func NewPluginID(id string) (PluginID, error)
  • func PluginIDFrom(id string) (PluginID, error)
  • func PluginIDFromRef(id *string) *PluginID
  • func PluginIDsFrom(ids []string) ([]PluginID, error)
  • func (d PluginID) Clone() PluginID
  • func (d *PluginID) CopyRef() *PluginID
  • func (d PluginID) Equal(d2 PluginID) bool
  • func (d PluginID) IsNil() bool
  • func (d *PluginID) MarshalText() ([]byte, error)
  • func (d PluginID) Ref() *PluginID
  • func (d PluginID) String() (s string)
  • func (d *PluginID) StringRef() *string
  • func (d *PluginID) UnmarshalText(text []byte) (err error)
  • func (d PluginID) Validate() bool
• type User
  • func (User) Type() string
• type UserID
• type UserIDList
• type UserIDSet
• type Version
  • func (Version) Type() string
• type VersionID
  • func NewVersionID(pid PluginID, version string) (VersionID, error)
  • func VersionIDFrom(id string) (VersionID, error)
  • func (i VersionID) PluginID() PluginID
  • func (i VersionID) String() string
  • func (i VersionID) Version() string

Variables

var ErrInvalidID = idx.ErrInvalidID

var NewOrganizationID = idx.New[Organization]

var NewUserID = idx.New[User]

var OrganizationIDFrom = idx.From[Organization]

var OrganizationIDsFrom = idx.ListFrom[Organization]

var UserIDFrom = idx.From[User]

var UserIDsFrom = idx.ListFrom[User]

Functions

func PluginIDsToStrings

func PluginIDsToStrings(ids []PluginID) []string

PluginIDsToStrings converts IDs into a string slice.

Types

type Organization

type Organization struct{}

func (Organization) Type

func (Organization) Type() string

type OrganizationID

type OrganizationID = idx.ID[Organization]

type OrganizationIDList

type OrganizationIDList = idx.List[Organization]

type Plugin

type Plugin struct{}

func (Plugin) Type

func (Plugin) Type() string

type PluginID

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

func MustPluginID

func MustPluginID(id string) PluginID

MustPluginID generates a new id.PluginID from a string, but panics if the string cannot be parsed.

func NewPluginID

func NewPluginID(id string) (PluginID, error)

func PluginIDFrom

func PluginIDFrom(id string) (PluginID, error)

PluginIDFrom generates a new id.PluginID from a string.

func PluginIDFromRef

func PluginIDFromRef(id *string) *PluginID

PluginIDFromRef generates a new id.PluginID from a string ref.

func PluginIDsFrom

func PluginIDsFrom(ids []string) ([]PluginID, error)

PluginIDsFrom converts a string slice into a ID slice.

func (PluginID) Clone

func (d PluginID) Clone() PluginID

Clone duplicates the PluginID

func (*PluginID) CopyRef

func (d *PluginID) CopyRef() *PluginID

func (PluginID) Equal

func (d PluginID) Equal(d2 PluginID) bool

Equal returns true if two IDs are equal.

func (PluginID) IsNil

func (d PluginID) IsNil() bool

IsNil checks if ID is empty or not.

func (*PluginID) MarshalText

func (d *PluginID) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler interface

func (PluginID) Ref

func (d PluginID) Ref() *PluginID

Ref returns a reference.

func (PluginID) String

func (d PluginID) String() (s string)

String returns a string representation.

func (*PluginID) StringRef

func (d *PluginID) StringRef() *string

StringRef returns a reference of a string representation.

func (*PluginID) UnmarshalText

func (d *PluginID) UnmarshalText(text []byte) (err error)

UnmarshalText implements encoding.TextUnmarshaler interface

func (PluginID) Validate

func (d PluginID) Validate() bool

Validate returns true if id is valid.

type User

type User struct{}

func (User) Type

func (User) Type() string

type UserID

type UserID = idx.ID[User]

type UserIDList

type UserIDList = idx.List[User]

type UserIDSet

type UserIDSet = idx.Set[User]

type Version

type Version struct{}

func (Version) Type

func (Version) Type() string

type VersionID

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

func NewVersionID

func NewVersionID(pid PluginID, version string) (VersionID, error)

func VersionIDFrom

func VersionIDFrom(id string) (VersionID, error)

func (VersionID) PluginID

func (i VersionID) PluginID() PluginID

func (VersionID) String

func (i VersionID) String() string

func (VersionID) Version

func (i VersionID) Version() string