manager

Documentation

Index

• Variables
• func ContextWithManager(ctx context.Context) context.Context
• func GetManager(ctx context.Context) (*manager, error)
• type CreateSessionArguments
• type ExportSessionArguments
• type ImportTemplateArguments
• type MonitorSessionArguments
• type PruneSessionArguments
• type SaveSessionAsTemplateArguments
• type Session
  • func (s *Session) IsActive() bool
  • func (s *Session) String() string
• type SessionDisplayType
  • func ParseSessionDisplayType(v string) (SessionDisplayType, error)
• type SessionSourceType
  • func (s SessionSourceType) FormattedString() string
  • func (s SessionSourceType) String() string
• type ShowSessionArguments
• type Source
  • func (s Source) FormattedValue() string
  • func (s Source) ShortValue() string
  • func (s Source) String() string
• type Template
  • func (t Template) AbsolutePath(ctx context.Context) string
  • func (t Template) FormattedString(ctx context.Context) string
  • func (t Template) StoragePath() string
  • func (t Template) String() string
• type UpdateTemplateArguments

Variables

var (
	ErrCurrentDirectoryIsNotASession = fmt.Errorf("current directory is not a session")
	ErrSessionNotFound               = fmt.Errorf("session not found")
)

var (
	ErrEditorNotFound = errors.New("editor not found")
)

var (
	ErrInvalidSessionDisplayType = errors.New("invalid session display type")
)

var (
	ErrInvalidSessionSource = errors.New("invalid session source")
)

var (
	ErrInvalidSourceType = errors.New("invalid source type, must be repository")
)

var (
	ErrManagerNotFound = fmt.Errorf("manager not found in context")
)

var (
	ErrMissingTemplateName = errors.New("missing template name")
)

var (
	ErrUnknownTrackingType = errors.New("unknown tracking type")
)

var (
	SessionDisplayTypes []SessionDisplayType = []SessionDisplayType{
		SessionDisplayTypeFull,
		SessionDisplayTypeLocation,
		SessionDisplayTypePID,
		SessionDisplayTypeEditor,
		SessionDisplayTypeJSON,
	}
)

Functions

func ContextWithManager

func ContextWithManager(ctx context.Context) context.Context

ContextWithManager returns a new context with the session manager

func GetManager

func GetManager(ctx context.Context) (*manager, error)

GetManager returns the session manager

Types

type CreateSessionArguments

type CreateSessionArguments struct {
	Source             string `json:"source"`
	ForceRequireExport bool   `json:"force_require_export"`
}

type ExportSessionArguments

type ExportSessionArguments struct {
	Path string
}

type ImportTemplateArguments

type ImportTemplateArguments struct {
	TemplateName  string
	RepositoryUrl string
}

type MonitorSessionArguments

type MonitorSessionArguments struct {
	Delay        time.Duration
	TrackingType editors.TrackingType
	PID          int
	Location     string
}

type PruneSessionArguments

type PruneSessionArguments struct {
	SessionID identifier.ID
}

type SaveSessionAsTemplateArguments

type SaveSessionAsTemplateArguments struct {
	TemplateName string `json:"template_name"`
}

type Session

type Session struct {
	ID       identifier.ID  `json:"id"`
	Location string         `json:"location"`
	PID      int            `json:"pid"`
	Source   Source         `json:"source"`
	Editor   editors.Editor `json:"editor"`
}

func (*Session) IsActive

func (s *Session) IsActive() bool

func (*Session) String

func (s *Session) String() string

type SessionDisplayType

type SessionDisplayType string

const (
	SessionDisplayTypeFull     SessionDisplayType = "full"
	SessionDisplayTypeLocation SessionDisplayType = "location"
	SessionDisplayTypePID      SessionDisplayType = "pid"
	SessionDisplayTypeEditor   SessionDisplayType = "editor"
	SessionDisplayTypeJSON     SessionDisplayType = "json"
)

func ParseSessionDisplayType

func ParseSessionDisplayType(v string) (SessionDisplayType, error)

type SessionSourceType

type SessionSourceType string

const (
	SessionSourceTypeRepository SessionSourceType = "repository"
	SessionSourceTypeDirectory  SessionSourceType = "directory"
	SessionSourceTypeTemplate   SessionSourceType = "template"
	SessionSourceTypeBlank      SessionSourceType = "blank"
)

func (SessionSourceType) FormattedString

func (s SessionSourceType) FormattedString() string

func (SessionSourceType) String

func (s SessionSourceType) String() string

type ShowSessionArguments

type ShowSessionArguments struct {
	SessionID  *identifier.ID
	OutputType SessionDisplayType
}

type Source

type Source struct {
	SourceType SessionSourceType `json:"sourceType"`
	Value      string            `json:"value"`
}

func (Source) FormattedValue

func (s Source) FormattedValue() string

func (Source) ShortValue

func (s Source) ShortValue() string

func (Source) String

func (s Source) String() string

type Template

type Template string

func (Template) AbsolutePath

func (t Template) AbsolutePath(ctx context.Context) string

func (Template) FormattedString

func (t Template) FormattedString(ctx context.Context) string

func (Template) StoragePath

func (t Template) StoragePath() string

func (Template) String

func (t Template) String() string

type UpdateTemplateArguments

type UpdateTemplateArguments struct {
	TemplateName string
}