clip

Documentation

Index

• func CreateAndUploadArchive(options CreateOptions, si common.ClipStorageInfo) error
• func CreateArchive(options CreateOptions) error
• func ExtractArchive(options ExtractOptions) error
• func MountArchive(options MountOptions) (func() error, <-chan error, error)
• func StoreS3(storeS3Opts StoreS3Options) error
• type CreateOptions
• type CreateRemoteOptions
• type ExtractOptions
• type MountOptions
• type StoreS3Options

Functions

func CreateAndUploadArchive

func CreateAndUploadArchive(options CreateOptions, si common.ClipStorageInfo) error

func CreateArchive

func CreateArchive(options CreateOptions) error

Create Archive

func ExtractArchive

func ExtractArchive(options ExtractOptions) error

Extract Archive

func MountArchive

func MountArchive(options MountOptions) (func() error, <-chan error, error)

Mount a clip archive to a directory

func StoreS3

func StoreS3(storeS3Opts StoreS3Options) error

Store CLIP in remote storage

Types

type CreateOptions

type CreateOptions struct {
	InputPath   string
	OutputPath  string
	Verbose     bool
	Credentials storage.ClipStorageCredentials
}

type CreateRemoteOptions

type CreateRemoteOptions struct {
	InputPath  string
	OutputPath string
	Verbose    bool
}

type ExtractOptions

type ExtractOptions struct {
	InputFile  string
	OutputPath string
	Verbose    bool
}

type MountOptions

type MountOptions struct {
	ArchivePath           string
	MountPoint            string
	Verbose               bool
	CachePath             string
	ContentCache          clipfs.ContentCache
	ContentCacheAvailable bool
	Credentials           storage.ClipStorageCredentials
}

type StoreS3Options

type StoreS3Options struct {
	ArchivePath string
	OutputFile  string
	Bucket      string
	Key         string
	CachePath   string
	Credentials storage.ClipStorageCredentials
}