clientzip

Documentation

Overview

Package clientzip provides clientside zipping functionality.

Index

• type File
  • func (f *File) Choose() client.Script
  • func (f *File) Dropzone() seed.Option
• type Policy
  • func (p Policy) String() string

Types

type File

type File struct {
	clientside.File

	ZipPolicy Policy

	//WhenZippingSet sets the file to set the given boolean when it is being zipped.
	WhenZippingSet *clientside.Bool
}

File is a (potentially zipped) file in client memory.

func (*File) Choose

func (f *File) Choose() client.Script

Choose asks the client to choose a File.

func (*File) Dropzone

func (f *File) Dropzone() seed.Option

Dropzone sets the seed to act as a dropzone for this file.

type Policy

type Policy int

Policy determines what is zipped.

const (
	//File is always zipped.
	Always Policy = iota

	//Only Folders are zipped, if a File is set to a single file, it will be left as is.
	FoldersOnly
)

Policies.

func (Policy) String

func (p Policy) String() string