Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

zim

package module

Go to main page

Versions in this module

v0

v0.1.3

Jul 18, 2021

v0.1.2

May 5, 2021

v0.1.1

May 5, 2021

v0.1.0

Nov 3, 2020

v0.0.1

Dec 18, 2019

Changes in this version

+ const MagicNumber

+ const MimetypeDeletedEntry

+ const MimetypeLinkTarget

+ const MimetypeRedirectEntry

+ const NamespaceArticleMetadata

+ const NamespaceArticles

+ const NamespaceCategoriesArticleList

+ const NamespaceCategoriesPerArticleCategoryList

+ const NamespaceCategoriesText

+ const NamespaceFulltextIndex

+ const NamespaceImagesFiles

+ const NamespaceImagesText

+ const NamespaceLayout

+ const NamespaceZimMetadata

+ const NoLayoutPage

+ const NoMainPage

+ type Cluster struct

+ func (c *Cluster) BlobAt(blobPosition uint32) ([]byte, error)

+ func (c *Cluster) WasCompressed() bool

+ type DirectoryEntry struct

+ func (e *DirectoryEntry) BlobNumber() uint32

+ func (e *DirectoryEntry) ClusterNumber() uint32

+ func (e *DirectoryEntry) IsArticle() bool

+ func (e *DirectoryEntry) IsDeletedEntry() bool

+ func (e *DirectoryEntry) IsLinkTarget() bool

+ func (e *DirectoryEntry) IsRedirect() bool

+ func (e *DirectoryEntry) Mimetype() Mimetype

+ func (e *DirectoryEntry) Namespace() Namespace

+ func (e *DirectoryEntry) RedirectIndex() uint32

+ func (e *DirectoryEntry) Revision() uint32

+ func (e *DirectoryEntry) String() string

+ func (e *DirectoryEntry) Title() []byte

+ func (e *DirectoryEntry) URL() []byte

+ type File struct

+ func Open(filename string) (*File, error)

+ func (z *File) ArticleCount() uint32

+ func (z *File) BlobReader(e *DirectoryEntry) (reader io.Reader, blobSize int64, err error)

+ func (z *File) BlobReaderAt(clusterPosition, blobPosition uint32) (reader io.Reader, blobSize int64, err error)

+ func (z *File) CalculateChecksum() ([md5.Size]byte, error)

+ func (z *File) Close()

+ func (z *File) ClusterAt(clusterPosition uint32) (Cluster, error)

+ func (z *File) ClusterCount() uint32

+ func (z *File) Counter() string

+ func (z *File) Creator() string

+ func (z *File) Date() string

+ func (z *File) Description() string

+ func (z *File) EntriesWithNamespace(namespace Namespace, limit int) []DirectoryEntry

+ func (z *File) EntriesWithSimilarity(namespace Namespace, prefix []byte, limit int) []DirectoryEntry

+ func (z *File) EntriesWithTitlePrefix(namespace Namespace, prefix []byte, limit int) []DirectoryEntry

+ func (z *File) EntriesWithURLPrefix(namespace Namespace, prefix []byte, limit int) []DirectoryEntry

+ func (z *File) EntryAtTitlePosition(position uint32) (DirectoryEntry, error)

+ func (z *File) EntryAtURLPosition(position uint32) (DirectoryEntry, error)

+ func (z *File) EntryWithNamespace(namespace Namespace) (entry DirectoryEntry, position uint32, found bool)

+ func (z *File) EntryWithTitlePrefix(namespace Namespace, prefix []byte) (entry DirectoryEntry, position uint32, found bool)

+ func (z *File) EntryWithURL(namespace Namespace, url []byte) (entry DirectoryEntry, urlPosition uint32, found bool)

+ func (z *File) EntryWithURLPrefix(namespace Namespace, prefix []byte) (entry DirectoryEntry, position uint32, found bool)

+ func (z *File) Favicon() (entry DirectoryEntry, err error)

+ func (z *File) Filename() string

+ func (z *File) Filesize() int

+ func (z *File) FollowRedirect(redirectEntry *DirectoryEntry) (DirectoryEntry, error)

+ func (z *File) InternalChecksum() ([md5.Size]byte, error)

+ func (z *File) Language() string

+ func (z *File) LayoutPage() (DirectoryEntry, error)

+ func (z *File) License() string

+ func (z *File) LongDescription() string

+ func (z *File) MainPage() (DirectoryEntry, error)

+ func (z *File) Metadata() map[string]string

+ func (z *File) MetadataFor(key string) string

+ func (z *File) MimetypeList() []string

+ func (z *File) Name() string

+ func (z *File) Publisher() string

+ func (z *File) Relation() string

+ func (z *File) Source() string

+ func (z *File) Tags() string

+ func (z *File) Title() string

+ func (z *File) UUID() UUID

+ func (z *File) ValidateChecksum() error

+ func (z *File) Version() (majorVersion, minorVersion uint16)

+ type Header struct

+ type Mimetype uint16

+ type Namespace byte

+ func (n Namespace) String() string

+ type UUID []byte

+ func (u UUID) String() string