preview

package
v0.10.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 31, 2026 License: MIT Imports: 40 Imported by: 0

Documentation

Overview

Package preview provides functionality for preview.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Highlight

func Highlight(filename, content string) (string, error)

Highlight ...

Types

type CodePreviewer

type CodePreviewer struct{}

CodePreviewer ...

func (*CodePreviewer) CanPreview

func (p *CodePreviewer) CanPreview(obj Object) bool

CanPreview ...

func (*CodePreviewer) Preview

func (p *CodePreviewer) Preview(ctx context.Context, client GCSClient, obj Object) (string, error)

Preview ...

func (*CodePreviewer) Priority

func (p *CodePreviewer) Priority() int

Priority ...

func (*CodePreviewer) SetWidth

func (p *CodePreviewer) SetWidth(_ int)

SetWidth ...

type ConfigPreviewer

type ConfigPreviewer struct{}

ConfigPreviewer ...

func (*ConfigPreviewer) CanPreview

func (p *ConfigPreviewer) CanPreview(obj Object) bool

CanPreview ...

func (*ConfigPreviewer) Preview

func (p *ConfigPreviewer) Preview(ctx context.Context, client GCSClient, obj Object) (string, error)

Preview ...

func (*ConfigPreviewer) Priority

func (p *ConfigPreviewer) Priority() int

Priority ...

func (*ConfigPreviewer) SetWidth

func (p *ConfigPreviewer) SetWidth(_ int)

SetWidth ...

type DataPreviewer

type DataPreviewer struct{}

DataPreviewer ...

func (*DataPreviewer) CanPreview

func (p *DataPreviewer) CanPreview(obj Object) bool

CanPreview ...

func (*DataPreviewer) Preview

func (p *DataPreviewer) Preview(ctx context.Context, client GCSClient, obj Object) (string, error)

Preview ...

func (*DataPreviewer) Priority

func (p *DataPreviewer) Priority() int

Priority ...

func (*DataPreviewer) SetWidth

func (p *DataPreviewer) SetWidth(_ int)

SetWidth ...

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) Preview added in v0.4.0

func (p *ImagePreviewer) Preview(ctx context.Context, client GCSClient, obj Object) (string, error)

Preview renders the image to an ANSI string.

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 ...

func (*LogPreviewer) CanPreview

func (p *LogPreviewer) CanPreview(obj Object) bool

CanPreview ...

func (*LogPreviewer) Preview

func (p *LogPreviewer) Preview(ctx context.Context, client GCSClient, obj Object) (string, error)

Preview ...

func (*LogPreviewer) Priority

func (p *LogPreviewer) Priority() int

Priority ...

func (*LogPreviewer) SetWidth

func (p *LogPreviewer) SetWidth(_ int)

SetWidth ...

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 ...

func (*MarkdownPreviewer) Preview

func (p *MarkdownPreviewer) Preview(ctx context.Context, client GCSClient, obj Object) (string, error)

Preview ...

func (*MarkdownPreviewer) Priority

func (p *MarkdownPreviewer) Priority() int

Priority ...

func (*MarkdownPreviewer) SetWidth

func (p *MarkdownPreviewer) SetWidth(width int)

SetWidth ...

type Object

type Object struct {
	Bucket      string
	Name        string
	Size        int64
	ContentType string
}

Object is a subset of gcs.ObjectMetadata needed for previewing.

type PDFPreviewer

type PDFPreviewer struct{}

PDFPreviewer ...

func (*PDFPreviewer) CanPreview

func (p *PDFPreviewer) CanPreview(obj Object) bool

CanPreview ...

func (*PDFPreviewer) Preview

func (p *PDFPreviewer) Preview(ctx context.Context, client GCSClient, obj Object) (string, error)

Preview ...

func (*PDFPreviewer) Priority

func (p *PDFPreviewer) Priority() int

Priority ...

func (*PDFPreviewer) SetWidth

func (p *PDFPreviewer) SetWidth(_ int)

SetWidth ...

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 NewRegistry

func NewRegistry() *Registry

NewRegistry ...

func (*Registry) GetPreview

func (r *Registry) GetPreview(ctx context.Context, client GCSClient, obj Object) (string, error)

GetPreview ...

func (*Registry) Register

func (r *Registry) Register(p Previewer)

Register ...

func (*Registry) SetWidth

func (r *Registry) SetWidth(width int)

SetWidth ...

type TarPreviewer

type TarPreviewer struct{}

TarPreviewer ...

func (*TarPreviewer) CanPreview

func (p *TarPreviewer) CanPreview(obj Object) bool

CanPreview ...

func (*TarPreviewer) Preview

func (p *TarPreviewer) Preview(ctx context.Context, client GCSClient, obj Object) (string, error)

Preview ...

func (*TarPreviewer) Priority

func (p *TarPreviewer) Priority() int

Priority ...

func (*TarPreviewer) SetWidth

func (p *TarPreviewer) SetWidth(_ int)

SetWidth ...

type TextPreviewer

type TextPreviewer struct{}

TextPreviewer ...

func (*TextPreviewer) CanPreview

func (p *TextPreviewer) CanPreview(_ Object) bool

CanPreview ...

func (*TextPreviewer) Preview

func (p *TextPreviewer) Preview(ctx context.Context, client GCSClient, obj Object) (string, error)

Preview ...

func (*TextPreviewer) Priority

func (p *TextPreviewer) Priority() int

Priority ...

func (*TextPreviewer) SetWidth

func (p *TextPreviewer) SetWidth(_ int)

SetWidth ...

type ZipPreviewer

type ZipPreviewer struct{}

ZipPreviewer ...

func (*ZipPreviewer) CanPreview

func (p *ZipPreviewer) CanPreview(obj Object) bool

CanPreview ...

func (*ZipPreviewer) Preview

func (p *ZipPreviewer) Preview(ctx context.Context, client GCSClient, obj Object) (string, error)

Preview ...

func (*ZipPreviewer) Priority

func (p *ZipPreviewer) Priority() int

Priority ...

func (*ZipPreviewer) SetWidth

func (p *ZipPreviewer) SetWidth(_ int)

SetWidth ...

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
⌂ 换网址