Documentation
¶
Index ¶
- Constants
- Variables
- type AddPackageOperationOpts
- type AddPackageOpts
- type AddProjectPackageOpts
- type Aggregate
- type AggregateMetricsResult
- type Blender
- type Catalog
- type Config
- type Configurator
- type Container
- type CreateMetricOpts
- type CreateProjectOpts
- type CreateProjectResult
- type Definition
- type DeleteMetricOpts
- type Dependency
- type Detail
- type Dispatcher
- type EventListener
- type Eventer
- type FeatureConfig
- type FilterMetricsOpts
- type GetMetricOpts
- type GetMetricResult
- type GetPackageOpts
- type GetPackageResponse
- type GetProjectOpts
- type GetProjectResponse
- type Index
- type IndexType
- type InstallPackageOpts
- type ListMetricsResult
- type ListPackagesResponse
- type ListProjectsResponse
- type Logger
- type Media
- type Metric
- type Operation
- type Operator
- type Package
- type PackageConfig
- type Portfolio
- type Progress
- type Project
- type ProjectConfig
- type RBConfigurator
- type RBDriver
- type RBRepository
- type RemovePackageOperationOpts
- type RemoveProjectPackageOpts
- type RunProjectOpts
- type Store
- type Tracker
- type UninstallPackageOpts
- type UpdateProjectOpts
- type Validator
- type Watcher
Constants ¶
View Source
const ApplicationName = "rocketblend-desktop"
View Source
const DetailFileName = "meta.json"
View Source
const IgnoreFileName = ".rocketignore"
View Source
const PackageFileName = types.PackageFileName
Variables ¶
View Source
var ErrNotImplement = errors.New("not implemented")
Functions ¶
This section is empty.
Types ¶
type AddPackageOperationOpts ¶
type AddPackageOpts ¶
type AddProjectPackageOpts ¶
type AggregateMetricsResult ¶
type AggregateMetricsResult struct {
Aggregate *Aggregate `json:"aggregate,omitempty"`
}
type Catalog ¶
type Catalog interface {
GetPackage(ctx context.Context, opts *GetPackageOpts) (*GetPackageResponse, error)
ListPackages(ctx context.Context, opts ...listoption.ListOption) (*ListPackagesResponse, error) // TODO: Change opts struct.
AddPackageOperation(ctx context.Context, opts *AddPackageOperationOpts) error
RemovePackageOperation(ctx context.Context, opts *RemovePackageOperationOpts) error
AddPackage(ctx context.Context, opts *AddPackageOpts) error
InstallPackage(ctx context.Context, opts *InstallPackageOpts) error
UninstallPackage(ctx context.Context, opts *UninstallPackageOpts) error
RefreshPackages(ctx context.Context) error
Close() error
}
type Config ¶
type Config struct {
Project ProjectConfig `mapstructure:"project"`
Package PackageConfig `mapstructure:"package"`
Feature FeatureConfig `mapstructure:"feature"`
}
type Configurator ¶
type Container ¶
type Container interface {
GetLogger() (Logger, error)
GetValidator() (Validator, error)
GetDispatcher() (Dispatcher, error)
GetTracker() (Tracker, error)
GetOperator() (Operator, error)
GetConfigurator() (Configurator, error)
GetRBConfigurator() (rbtypes.Configurator, error)
GetRBDriver() (rbtypes.Driver, error)
GetBlender() (rbtypes.Blender, error)
GetStore() (Store, error)
GetPortfolio() (Portfolio, error)
GetCatalog() (Catalog, error)
}
type CreateMetricOpts ¶
type CreateProjectOpts ¶
type CreateProjectResult ¶
type Definition ¶
type DeleteMetricOpts ¶
type Dependency ¶
type Dependency struct {
Reference reference.Reference `json:"reference"`
Type enums.PackageType `json:"type"`
}
type Dispatcher ¶
type Dispatcher interface {
Subscribe(ctx context.Context, name string, fn interface{}, maxTrigger int) (context.CancelFunc, error)
EmitEvent(ctx context.Context, name string, params ...interface{}) error
Broadcast(ctx context.Context, params ...interface{}) error
EventExists(name string) bool
ListEvents() []string
FilterEvents(filterFunc func(string, []EventListener) bool) []string
CountListeners(eventName string) int
Close() error
}
type EventListener ¶
type FeatureConfig ¶
type FilterMetricsOpts ¶
type GetMetricOpts ¶
type GetMetricResult ¶
type GetMetricResult struct {
Metric *Metric `json:"metric,omitempty"`
}
type GetPackageOpts ¶
type GetPackageResponse ¶
type GetPackageResponse struct {
Package *Package `json:"package,omitempty"`
}
type GetProjectOpts ¶
type GetProjectResponse ¶
type GetProjectResponse struct {
Project *Project `json:"project,omitempty"`
}
type Index ¶
type Index struct {
ID uuid.UUID `json:"id,omitempty"`
Type indextype.IndexType `json:"type,omitempty"`
Reference string `json:"reference,omitempty"`
Name string `json:"name,omitempty"`
Category string `json:"category,omitempty"`
State string `json:"state"`
Resources []string `json:"resources,omitempty"`
Operations []string `json:"operations,omitempty"`
Date time.Time `json:"date,omitempty"`
Data string `json:"data,omitempty"`
}
type IndexType ¶
type IndexType int
func PackageTypeFromString ¶
func (IndexType) MarshalJSON ¶
func (*IndexType) UnmarshalJSON ¶
type InstallPackageOpts ¶
type ListMetricsResult ¶
type ListMetricsResult struct {
Metrics []*Metric `json:"metrics,omitempty"`
}
type ListPackagesResponse ¶
type ListPackagesResponse struct {
Packages []*Package `json:"packages,omitempty"`
}
type ListProjectsResponse ¶
type ListProjectsResponse struct {
Projects []*Project `json:"projects,omitempty"`
}
type Operator ¶
type Operator interface {
Create(ctx context.Context, opFunc func(ctx context.Context, opid uuid.UUID) (interface{}, error)) (uuid.UUID, error)
Get(ctx context.Context, opid uuid.UUID) (*Operation, error)
List(ctx context.Context, opts ...listoption.ListOption) ([]*Operation, error)
Cancel(opid uuid.UUID) error
}
type Package ¶
type Package struct {
ID uuid.UUID `json:"id"`
Type enums.PackageType `json:"type"`
State enums.PackageState `json:"state"`
Reference reference.Reference `json:"reference"`
Name string `json:"name"`
Author string `json:"author"`
Tag string `json:"tag"`
Path string `json:"path"`
Verified bool `json:"verified"`
InstallationPath string `json:"installationPath"`
Operations []string `json:"operations"`
Platform types.Platform `json:"platform"`
URI *types.URI `json:"uri"`
Version *semver.Version `json:"version"`
Progress *Progress `json:"progress,omitempty"`
UpdatedAt time.Time `json:"updatedAt"`
}
type PackageConfig ¶
type PackageConfig struct {
AutoPull bool `mapstructure:"autoPull"`
}
type Portfolio ¶
type Portfolio interface {
GetProject(ctx context.Context, opts *GetProjectOpts) (*GetProjectResponse, error)
ListProjects(ctx context.Context, opts ...listoption.ListOption) (*ListProjectsResponse, error)
CreateProject(ctx context.Context, opts *CreateProjectOpts) (*CreateProjectResult, error)
UpdateProject(ctx context.Context, opts *UpdateProjectOpts) error
AddProjectPackage(ctx context.Context, opts *AddProjectPackageOpts) error
RemoveProjectPackage(ctx context.Context, opts *RemoveProjectPackageOpts) error
//RenderProject(ctx context.Context, id uuid.UUID) error
RunProject(ctx context.Context, opts *RunProjectOpts) error
Refresh(ctx context.Context) error
Close() error
}
type Project ¶
type Project struct {
ID uuid.UUID `json:"id"`
Name string `json:"name"`
Tags []string `json:"tags"`
Path string `json:"path"`
MediaPath string `json:"mediaPath"`
FileName string `json:"fileName"`
Dependencies []*Dependency `json:"dependencies"`
Media []*Media `json:"media"`
Strict bool `json:"strict"`
Version string `json:"version"`
UpdatedAt time.Time `json:"updatedAt"`
}
type ProjectConfig ¶
type ProjectConfig struct {
Paths []string `mapstructure:"paths"`
}
type RBConfigurator ¶
type RBConfigurator interface {
types.Configurator
}
type RBRepository ¶
type RBRepository interface {
types.Repository
}
type RunProjectOpts ¶
type Store ¶
type Store interface {
List(ctx context.Context, opts ...listoption.ListOption) ([]*Index, error)
Get(ctx context.Context, id uuid.UUID) (*Index, error)
Insert(ctx context.Context, index *Index) error
Remove(ctx context.Context, id uuid.UUID) error
RemoveByReference(ctx context.Context, path string) error
Close() error
}
type Tracker ¶
type Tracker interface {
GetMetric(ctx context.Context, opts *GetMetricOpts) (*GetMetricResult, error)
ListMetrics(ctx context.Context, opts *FilterMetricsOpts) (*ListMetricsResult, error)
AggregateMetrics(ctx context.Context, opts *FilterMetricsOpts) (*AggregateMetricsResult, error)
CreateMetric(ctx context.Context, opts *CreateMetricOpts) error
DeleteMetric(ctx context.Context, opts *DeleteMetricOpts) error
}
type UninstallPackageOpts ¶
type UpdateProjectOpts ¶
Click to show internal directories.
Click to hide internal directories.