Documentation ¶
Index ¶
- Variables
- func PluginIDsToStrings(ids []PluginID) []string
- func PropertySchemaIDsToStrings(ids []PropertySchemaID) []string
- type Asset
- type AssetID
- type AssetIDList
- type AssetIDSet
- type AuthRequest
- type AuthRequestID
- type AuthRequestIDList
- type AuthRequestIDSet
- type Cluster
- type ClusterID
- type ClusterIDList
- type ClusterIDSet
- type Dataset
- type DatasetField
- type DatasetFieldID
- type DatasetFieldIDList
- type DatasetFieldIDSet
- type DatasetID
- type DatasetIDList
- type DatasetIDSet
- type DatasetSchema
- type DatasetSchemaID
- type DatasetSchemaIDList
- type DatasetSchemaIDSet
- type InfoboxField
- type InfoboxFieldID
- type InfoboxFieldIDList
- type InfoboxFieldIDSet
- type Layer
- type LayerID
- type LayerIDList
- type LayerIDSet
- type PluginExtension
- type PluginExtensionID
- type PluginID
- 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) Name() string
- func (d PluginID) Ref() *PluginID
- func (d PluginID) Scene() *SceneID
- func (d PluginID) String() (s string)
- func (d *PluginID) StringRef() *string
- func (d PluginID) System() bool
- func (d *PluginID) UnmarshalText(text []byte) (err error)
- func (d PluginID) Validate() bool
- func (d PluginID) Version() semver.Version
- func (d PluginID) WithScene(sid *SceneID) PluginID
- type Project
- type ProjectID
- type ProjectIDList
- type ProjectIDSet
- type Property
- type PropertyField
- type PropertyFieldID
- type PropertyID
- type PropertyIDList
- type PropertyIDSet
- type PropertyItem
- type PropertyItemID
- type PropertyItemIDList
- type PropertyItemIDSet
- type PropertySchemaGroup
- type PropertySchemaGroupID
- type PropertySchemaID
- func MustPropertySchemaID(id string) PropertySchemaID
- func NewPropertySchemaID(p PluginID, name string) PropertySchemaID
- func PropertySchemaIDFrom(id string) (PropertySchemaID, error)
- func PropertySchemaIDFromRef(id *string) *PropertySchemaID
- func PropertySchemaIDsFrom(ids []string) ([]PropertySchemaID, error)
- func (d PropertySchemaID) Clone() PropertySchemaID
- func (d *PropertySchemaID) CopyRef() *PropertySchemaID
- func (d PropertySchemaID) Equal(d2 PropertySchemaID) bool
- func (d PropertySchemaID) ID() string
- func (d PropertySchemaID) IsNil() bool
- func (d *PropertySchemaID) MarshalText() ([]byte, error)
- func (d PropertySchemaID) Plugin() PluginID
- func (d PropertySchemaID) Ref() *PropertySchemaID
- func (d PropertySchemaID) String() string
- func (d *PropertySchemaID) StringRef() *string
- func (d *PropertySchemaID) UnmarshalText(text []byte) (err error)
- func (d PropertySchemaID) WithPlugin(plugin PluginID) PropertySchemaID
- type Scene
- type SceneID
- type SceneIDList
- type SceneIDSet
- type Tag
- type TagID
- type TagIDList
- type TagIDSet
- type Team
- type TeamID
- type TeamIDList
- type TeamIDSet
- type User
- type UserID
- type UserIDList
- type UserIDSet
- type Widget
- type WidgetID
- type WidgetIDList
- type WidgetIDSet
Constants ¶
This section is empty.
Variables ¶
var AssetIDFrom = idx.From[Asset]
var AssetIDFromRef = idx.FromRef[Asset]
var AssetIDListFrom = idx.ListFrom[Asset]
var AuthRequestIDFrom = idx.From[AuthRequest]
var AuthRequestIDFromRef = idx.FromRef[AuthRequest]
var AuthRequestIDListFrom = idx.ListFrom[AuthRequest]
var ClusterIDFrom = idx.From[Cluster]
var ClusterIDFromRef = idx.FromRef[Cluster]
var ClusterIDListFrom = idx.ListFrom[Cluster]
var DatasetFieldIDFrom = idx.From[DatasetField]
var DatasetFieldIDFromRef = idx.FromRef[DatasetField]
var DatasetFieldIDListFrom = idx.ListFrom[DatasetField]
var DatasetIDFrom = idx.From[Dataset]
var DatasetIDFromRef = idx.FromRef[Dataset]
var DatasetIDListFrom = idx.ListFrom[Dataset]
var DatasetSchemaIDFrom = idx.From[DatasetSchema]
var DatasetSchemaIDFromRef = idx.FromRef[DatasetSchema]
var DatasetSchemaIDListFrom = idx.ListFrom[DatasetSchema]
var ErrInvalidID = idx.ErrInvalidID
var InfoboxFieldIDFrom = idx.From[InfoboxField]
var InfoboxFieldIDFromRef = idx.FromRef[InfoboxField]
var InfoboxFieldIDListFrom = idx.ListFrom[InfoboxField]
var LayerIDFrom = idx.From[Layer]
var LayerIDFromRef = idx.FromRef[Layer]
var LayerIDListFrom = idx.ListFrom[Layer]
var MustAssetID = idx.Must[Asset]
var MustAuthRequestID = idx.Must[AuthRequest]
var MustClusterID = idx.Must[Cluster]
var MustDatasetFieldID = idx.Must[DatasetField]
var MustDatasetID = idx.Must[Dataset]
var MustDatasetSchemaID = idx.Must[DatasetSchema]
var MustInfoboxFieldID = idx.Must[InfoboxField]
var MustLayerID = idx.Must[Layer]
var MustProjectID = idx.Must[Project]
var MustPropertyID = idx.Must[Property]
var MustPropertyItemID = idx.Must[PropertyItem]
var MustSceneID = idx.Must[Scene]
var MustTagID = idx.Must[Tag]
var MustTeamID = idx.Must[Team]
var MustUserID = idx.Must[User]
var MustWidgetID = idx.Must[Widget]
var NewAssetID = idx.New[Asset]
var NewAssetIDSet = idx.NewSet[Asset]
var NewAuthRequestID = idx.New[AuthRequest]
var NewAuthRequestIDSet = idx.NewSet[AuthRequest]
var NewClusterID = idx.New[Cluster]
var NewClusterIDSet = idx.NewSet[Cluster]
var NewDatasetFieldID = idx.New[DatasetField]
var NewDatasetFieldIDSet = idx.NewSet[DatasetField]
var NewDatasetID = idx.New[Dataset]
var NewDatasetIDSet = idx.NewSet[Dataset]
var NewDatasetSchemaID = idx.New[DatasetSchema]
var NewDatasetSchemaIDSet = idx.NewSet[DatasetSchema]
var NewInfoboxFieldID = idx.New[InfoboxField]
var NewInfoboxFieldIDSet = idx.NewSet[InfoboxField]
var NewLayerID = idx.New[Layer]
var NewLayerIDSet = idx.NewSet[Layer]
var NewProjectID = idx.New[Project]
var NewProjectIDSet = idx.NewSet[Project]
var NewPropertyID = idx.New[Property]
var NewPropertyIDSet = idx.NewSet[Property]
var NewPropertyItemID = idx.New[PropertyItem]
var NewPropertyItemIDSet = idx.NewSet[PropertyItem]
var NewSceneID = idx.New[Scene]
var NewSceneIDSet = idx.NewSet[Scene]
var NewTagID = idx.New[Tag]
var NewTagIDSet = idx.NewSet[Tag]
var NewTeamID = idx.New[Team]
var NewTeamIDSet = idx.NewSet[Team]
var NewUserID = idx.New[User]
var NewUserIDSet = idx.NewSet[User]
var NewWidgetID = idx.New[Widget]
var NewWidgetIDSet = idx.NewSet[Widget]
var (
OfficialPluginID = PluginID{/* contains filtered or unexported fields */}
)
var PluginExtensionIDFromRef = idx.StringIDFromRef[PluginExtension]
var ProjectIDFrom = idx.From[Project]
var ProjectIDFromRef = idx.FromRef[Project]
var ProjectIDListFrom = idx.ListFrom[Project]
var PropertyFieldIDFromRef = idx.StringIDFromRef[PropertyField]
var PropertyIDFrom = idx.From[Property]
var PropertyIDFromRef = idx.FromRef[Property]
var PropertyIDListFrom = idx.ListFrom[Property]
var PropertyItemIDFrom = idx.From[PropertyItem]
var PropertyItemIDFromRef = idx.FromRef[PropertyItem]
var PropertyItemIDListFrom = idx.ListFrom[PropertyItem]
var PropertySchemaGroupIDFromRef = idx.StringIDFromRef[PropertySchemaGroup]
var SceneIDFrom = idx.From[Scene]
var SceneIDFromRef = idx.FromRef[Scene]
var SceneIDListFrom = idx.ListFrom[Scene]
var TagIDFrom = idx.From[Tag]
var TagIDFromRef = idx.FromRef[Tag]
var TagIDListFrom = idx.ListFrom[Tag]
var TeamIDFrom = idx.From[Team]
var TeamIDFromRef = idx.FromRef[Team]
var TeamIDListFrom = idx.ListFrom[Team]
var UserIDFrom = idx.From[User]
var UserIDFromRef = idx.FromRef[User]
var UserIDListFrom = idx.ListFrom[User]
var WidgetIDFrom = idx.From[Widget]
var WidgetIDFromRef = idx.FromRef[Widget]
var WidgetIDListFrom = idx.ListFrom[Widget]
Functions ¶
func PluginIDsToStrings ¶ added in v0.4.0
PluginIDToKeys converts IDs into a string slice.
func PropertySchemaIDsToStrings ¶ added in v0.4.0
func PropertySchemaIDsToStrings(ids []PropertySchemaID) []string
PropertySchemaIDToKeys converts IDs into a string slice.
Types ¶
type AssetIDList ¶ added in v0.6.1
type AssetIDSet ¶
type AuthRequest ¶ added in v0.6.1
type AuthRequest struct{}
func (AuthRequest) Type ¶ added in v0.6.1
func (AuthRequest) Type() string
type AuthRequestID ¶ added in v0.6.0
type AuthRequestID = idx.ID[AuthRequest]
type AuthRequestIDList ¶ added in v0.6.1
type AuthRequestIDList = idx.List[AuthRequest]
type AuthRequestIDSet ¶ added in v0.6.0
type AuthRequestIDSet = idx.Set[AuthRequest]
type ClusterIDList ¶ added in v0.6.1
type ClusterIDSet ¶ added in v0.3.0
type DatasetField ¶ added in v0.6.1
type DatasetField struct{}
func (DatasetField) Type ¶ added in v0.6.1
func (DatasetField) Type() string
type DatasetFieldID ¶ added in v0.6.1
type DatasetFieldID = idx.ID[DatasetField]
type DatasetFieldIDList ¶ added in v0.6.1
type DatasetFieldIDList = idx.List[DatasetField]
type DatasetFieldIDSet ¶ added in v0.6.1
type DatasetFieldIDSet = idx.Set[DatasetField]
type DatasetIDList ¶ added in v0.6.1
type DatasetIDSet ¶
type DatasetSchema ¶ added in v0.6.1
type DatasetSchema struct{}
func (DatasetSchema) Type ¶ added in v0.6.1
func (DatasetSchema) Type() string
type DatasetSchemaID ¶
type DatasetSchemaID = idx.ID[DatasetSchema]
type DatasetSchemaIDList ¶ added in v0.6.1
type DatasetSchemaIDList = idx.List[DatasetSchema]
type DatasetSchemaIDSet ¶
type DatasetSchemaIDSet = idx.Set[DatasetSchema]
type InfoboxField ¶ added in v0.6.1
type InfoboxField struct{}
func (InfoboxField) Type ¶ added in v0.6.1
func (InfoboxField) Type() string
type InfoboxFieldID ¶
type InfoboxFieldID = idx.ID[InfoboxField]
type InfoboxFieldIDList ¶ added in v0.6.1
type InfoboxFieldIDList = idx.List[InfoboxField]
type InfoboxFieldIDSet ¶
type InfoboxFieldIDSet = idx.Set[InfoboxField]
type LayerIDList ¶ added in v0.6.1
type LayerIDSet ¶
type PluginExtension ¶ added in v0.6.1
type PluginExtension struct{}
func (PluginExtension) Type ¶ added in v0.6.1
func (PluginExtension) Type() string
type PluginExtensionID ¶
type PluginExtensionID = idx.StringID[PluginExtension]
type PluginID ¶
type PluginID struct {
// contains filtered or unexported fields
}
func MustPluginID ¶
MustPluginID generates a new id.PluginID from a string, but panics if the string cannot be parsed.
func PluginIDFrom ¶
PluginIDFrom generates a new id.PluginID from a string.
func PluginIDFromRef ¶
PluginIDFromRef generates a new id.PluginID from a string ref.
func PluginIDsFrom ¶
PluginIDsFrom converts a string slice into a ID slice.
func (*PluginID) MarshalText ¶
MarshalText implements encoding.TextMarshaler interface
func (PluginID) Scene ¶
Scene returns a scene ID of the plugin. It indicates this plugin is private and available for only the specific scene.
func (*PluginID) UnmarshalText ¶
UnmarshalText implements encoding.TextUnmarshaler interface
type ProjectIDList ¶ added in v0.6.1
type ProjectIDSet ¶
type PropertyField ¶ added in v0.6.1
type PropertyField struct{}
func (PropertyField) Type ¶ added in v0.6.1
func (PropertyField) Type() string
type PropertyFieldID ¶ added in v0.6.1
type PropertyFieldID = idx.StringID[PropertyField]
type PropertyID ¶
type PropertyIDList ¶ added in v0.6.1
type PropertyIDSet ¶
type PropertyItem ¶ added in v0.6.1
type PropertyItem struct{}
func (PropertyItem) Type ¶ added in v0.6.1
func (PropertyItem) Type() string
type PropertyItemID ¶
type PropertyItemID = idx.ID[PropertyItem]
type PropertyItemIDList ¶ added in v0.6.1
type PropertyItemIDList = idx.List[PropertyItem]
type PropertyItemIDSet ¶
type PropertyItemIDSet = idx.Set[PropertyItem]
type PropertySchemaGroup ¶ added in v0.6.1
type PropertySchemaGroup struct{}
func (PropertySchemaGroup) Type ¶ added in v0.6.1
func (PropertySchemaGroup) Type() string
type PropertySchemaGroupID ¶ added in v0.2.0
type PropertySchemaGroupID = idx.StringID[PropertySchemaGroup]
type PropertySchemaID ¶
type PropertySchemaID struct {
// contains filtered or unexported fields
}
func MustPropertySchemaID ¶
func MustPropertySchemaID(id string) PropertySchemaID
MustPropertySchemaID generates a new PropertySchemaID from a string, but panics if the string cannot be parsed.
func NewPropertySchemaID ¶ added in v0.5.0
func NewPropertySchemaID(p PluginID, name string) PropertySchemaID
NewPropertySchemaID generates a new PropertySchemaID from a plugin ID and name.
func PropertySchemaIDFrom ¶
func PropertySchemaIDFrom(id string) (PropertySchemaID, error)
PropertySchemaIDFrom generates a new PropertySchemaID from a string.
func PropertySchemaIDFromRef ¶
func PropertySchemaIDFromRef(id *string) *PropertySchemaID
PropertySchemaIDFromRef generates a new PropertySchemaID from a string ref.
func PropertySchemaIDsFrom ¶
func PropertySchemaIDsFrom(ids []string) ([]PropertySchemaID, error)
PropertySchemaIDsFrom converts a string slice into a ID slice.
func (PropertySchemaID) Clone ¶ added in v0.4.0
func (d PropertySchemaID) Clone() PropertySchemaID
Clone duplicates the PropertySchemaID
func (*PropertySchemaID) CopyRef ¶
func (d *PropertySchemaID) CopyRef() *PropertySchemaID
CopyRef returns a copy of a reference.
func (PropertySchemaID) Equal ¶
func (d PropertySchemaID) Equal(d2 PropertySchemaID) bool
Equal returns true if two IDs are equal.
func (PropertySchemaID) ID ¶
func (d PropertySchemaID) ID() string
ID returns a fragment of just ID.
func (PropertySchemaID) IsNil ¶
func (d PropertySchemaID) IsNil() bool
IsNil checks if ID is empty or not.
func (*PropertySchemaID) MarshalText ¶
func (d *PropertySchemaID) MarshalText() ([]byte, error)
MarshalText implements encoding.TextMarshaler interface
func (PropertySchemaID) Plugin ¶
func (d PropertySchemaID) Plugin() PluginID
Plugin returns a fragment of plugin ID.
func (PropertySchemaID) Ref ¶
func (d PropertySchemaID) Ref() *PropertySchemaID
Ref returns a reference.
func (PropertySchemaID) String ¶
func (d PropertySchemaID) String() string
String returns a string representation.
func (*PropertySchemaID) StringRef ¶
func (d *PropertySchemaID) StringRef() *string
StringRef returns a reference of a string representation.
func (*PropertySchemaID) UnmarshalText ¶
func (d *PropertySchemaID) UnmarshalText(text []byte) (err error)
UnmarshalText implements encoding.TextUnmarshaler interface
func (PropertySchemaID) WithPlugin ¶ added in v0.5.0
func (d PropertySchemaID) WithPlugin(plugin PluginID) PropertySchemaID
WithPlugin duplicates the PropertySchemaID but its plugin ID is changed