Documentation
¶
Overview ¶
Package preview provides functionality for preview.
Index ¶
- func Highlight(filename, content string) (string, error)
- type CodePreviewer
- type ConfigPreviewer
- type DataPreviewer
- type DockerArchivePreviewer
- type DockerManifestPreviewer
- type GCSClient
- type ImagePreviewer
- type LogPreviewer
- type MarkdownPreviewer
- type Object
- type PDFPreviewer
- type Previewer
- type Registry
- type TarPreviewer
- type TextPreviewer
- type ZipPreviewer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type CodePreviewer ¶
type CodePreviewer struct{}
CodePreviewer ...
func (*CodePreviewer) CanPreview ¶
func (p *CodePreviewer) CanPreview(obj Object) bool
CanPreview ...
type ConfigPreviewer ¶
type ConfigPreviewer struct{}
ConfigPreviewer ...
func (*ConfigPreviewer) CanPreview ¶
func (p *ConfigPreviewer) CanPreview(obj Object) bool
CanPreview ...
type DataPreviewer ¶
type DataPreviewer struct{}
DataPreviewer ...
func (*DataPreviewer) CanPreview ¶
func (p *DataPreviewer) CanPreview(obj Object) bool
CanPreview ...
type DockerArchivePreviewer ¶ added in v0.5.0
type DockerArchivePreviewer struct{}
DockerArchivePreviewer ...
func (*DockerArchivePreviewer) CanPreview ¶ added in v0.5.0
func (p *DockerArchivePreviewer) CanPreview(obj Object) bool
CanPreview ...
func (*DockerArchivePreviewer) Preview ¶ added in v0.5.0
func (p *DockerArchivePreviewer) Preview(ctx context.Context, client GCSClient, obj Object) (string, error)
Preview ...
func (*DockerArchivePreviewer) Priority ¶ added in v0.5.0
func (p *DockerArchivePreviewer) Priority() int
Priority ...
func (*DockerArchivePreviewer) SetWidth ¶ added in v0.5.0
func (p *DockerArchivePreviewer) SetWidth(_ int)
SetWidth ...
type DockerManifestPreviewer ¶ added in v0.5.0
type DockerManifestPreviewer struct{}
DockerManifestPreviewer ...
func (*DockerManifestPreviewer) CanPreview ¶ added in v0.5.0
func (p *DockerManifestPreviewer) CanPreview(obj Object) bool
CanPreview ...
func (*DockerManifestPreviewer) Preview ¶ added in v0.5.0
func (p *DockerManifestPreviewer) Preview(ctx context.Context, client GCSClient, obj Object) (string, error)
Preview ...
func (*DockerManifestPreviewer) Priority ¶ added in v0.5.0
func (p *DockerManifestPreviewer) Priority() int
Priority ...
func (*DockerManifestPreviewer) SetWidth ¶ added in v0.5.0
func (p *DockerManifestPreviewer) SetWidth(_ int)
SetWidth ...
type GCSClient ¶
type GCSClient interface {
GetObjectContent(ctx context.Context, bucketName, objectName string) (string, error)
NewReader(ctx context.Context, bucketName, objectName string) (io.ReadCloser, error)
NewReaderAt(ctx context.Context, bucketName, objectName string) io.ReaderAt
}
GCSClient defines the methods required from the GCS client for previewing.
type ImagePreviewer ¶ added in v0.4.0
type ImagePreviewer struct {
// contains filtered or unexported fields
}
ImagePreviewer handles image files.
func (*ImagePreviewer) CanPreview ¶ added in v0.4.0
func (p *ImagePreviewer) CanPreview(obj Object) bool
CanPreview determines if this previewer should handle the object.
func (*ImagePreviewer) Priority ¶ added in v0.4.0
func (p *ImagePreviewer) Priority() int
Priority defines the order of evaluation.
func (*ImagePreviewer) SetWidth ¶ added in v0.4.0
func (p *ImagePreviewer) SetWidth(width int)
SetWidth updates the preferred rendering width.
type LogPreviewer ¶
type LogPreviewer struct{}
LogPreviewer ...
type MarkdownPreviewer ¶
type MarkdownPreviewer struct {
// contains filtered or unexported fields
}
MarkdownPreviewer ...
func NewMarkdownPreviewer ¶
func NewMarkdownPreviewer(width int) *MarkdownPreviewer
NewMarkdownPreviewer ...
func (*MarkdownPreviewer) CanPreview ¶
func (p *MarkdownPreviewer) CanPreview(obj Object) bool
CanPreview ...
type PDFPreviewer ¶
type PDFPreviewer struct{}
PDFPreviewer ...
type Previewer ¶
type Previewer interface {
// Priority defines the order of evaluation (lower is higher priority).
Priority() int
// CanPreview determines if this previewer should handle the object.
CanPreview(obj Object) bool
// Preview returns the fully rendered ANSI string.
Preview(ctx context.Context, client GCSClient, obj Object) (string, error)
// SetWidth updates the preferred rendering width.
SetWidth(width int)
}
Previewer ...
type Registry ¶
type Registry struct {
// contains filtered or unexported fields
}
Registry ...
func NewDefaultRegistry ¶ added in v0.8.0
func NewDefaultRegistry() *Registry
NewDefaultRegistry returns a Registry with all standard previewers registered.
func (*Registry) GetPreview ¶
GetPreview ...
type TarPreviewer ¶
type TarPreviewer struct{}
TarPreviewer ...
type TextPreviewer ¶
type TextPreviewer struct{}
TextPreviewer ...
type ZipPreviewer ¶
type ZipPreviewer struct{}
ZipPreviewer ...