Reference API

Class Hierarchy

File Hierarchy

Full API

Namespaces

• Namespace std

• Namespace Xapian

• Namespace zim
  • Namespaces
  • Classes
  • Enums
  • Functions
  • Typedefs
  • Variables

• Namespace zim::unix

• Namespace zim::writer
  • Classes
  • Enums
  • Typedefs

Classes and Structs

• Struct FdInput
  • Struct Documentation
    • zim::FdInput
      • FdInput()
      • fd
      • offset
      • size

• Struct IllustrationInfo
  • Struct Documentation
    • zim::IllustrationInfo
      • asMetadataItemName()
      • width
      • height
      • scale
      • extraAttributes
      • fromMetadataItemName()

• Struct ItemDataDirectAccessInfo
  • Struct Documentation
    • zim::ItemDataDirectAccessInfo
      • ItemDataDirectAccessInfo()
      • ItemDataDirectAccessInfo()
      • isValid()
      • filename
      • offset

• Struct OpenConfig
  • Struct Documentation
    • zim::OpenConfig
      • OpenConfig()
      • preloadXapianDb()
      • preloadXapianDb()
      • preloadDirentRanges()
      • preloadDirentRanges()
      • m_preloadXapianDb
      • m_preloadDirentRanges

• Struct Uuid
  • Struct Documentation
    • zim::Uuid
      • Uuid()
      • Uuid()
      • operator==()
      • operator!=()
      • size()
      • operator std::string()
      • data
      • generate()

• Class Archive
  • Nested Relationships
    • Nested Types
  • Class Documentation
    • zim::Archive
      • IllustrationInfos
      • Archive()
      • Archive()
      • Archive()
      • Archive()
      • Archive()
      • Archive()
      • Archive()
      • Archive()
      • Archive()
      • Archive()
      • getFilename()
      • getFilesize()
      • getAllEntryCount()
      • getEntryCount()
      • getArticleCount()
      • getMediaCount()
      • getUuid()
      • getMetadata()
      • getMetadataItem()
      • getMetadataKeys()
      • getIllustrationItem()
      • getIllustrationItem()
      • getIllustrationSizes()
      • getIllustrationInfos()
      • getIllustrationInfos()
      • getEntryByPath()
      • getEntryByPath()
      • getEntryByTitle()
      • getEntryByTitle()
      • getEntryByClusterOrder()
      • getMainEntry()
      • getRandomEntry()
      • hasEntryByPath()
      • hasEntryByTitle()
      • hasMainEntry()
      • hasIllustration()
      • hasFulltextIndex()
      • hasTitleIndex()
      • iterByPath()
      • iterByTitle()
      • iterEfficient()
      • findByPath()
      • findByTitle()
      • hasChecksum()
      • getChecksum()
      • check()
      • checkIntegrity()
      • isMultiPart()
      • hasNewNamespaceScheme()
      • getImpl()
      • getDirentCacheMaxSize()
      • getDirentCacheCurrentSize()
      • setDirentCacheMaxSize()
      • zim::Archive::EntryRange
        • EntryRange()
        • begin()
        • end()
        • size()
        • offset()
      • zim::Archive::iterator
        • iterator_category
        • value_type
        • pointer
        • reference
        • iterator()
        • iterator()
        • operator==()
        • operator!=()
        • operator=()
        • operator=()
        • operator++()
        • operator++()
        • operator--()
        • operator--()
        • operator*()
        • operator->()

• Template Class Archive::EntryRange
  • Nested Relationships
  • Class Documentation
    • zim::Archive::EntryRange
      • EntryRange()
      • begin()
      • end()
      • size()
      • offset()

• Template Class Archive::iterator
  • Nested Relationships
  • Class Documentation
    • zim::Archive::iterator
      • iterator_category
      • value_type
      • pointer
      • reference
      • iterator()
      • iterator()
      • operator==()
      • operator!=()
      • operator=()
      • operator=()
      • operator++()
      • operator++()
      • operator--()
      • operator--()
      • operator*()
      • operator->()

• Class AsyncError
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • zim::AsyncError
      • AsyncError()
      • rethrow()

• Class Attributes
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • zim::Attributes
      • Attributes()
      • Attributes()
      • Attributes()
      • parse()

• Class Blob
  • Class Documentation
    • zim::Blob
      • DataPtr
      • Blob()
      • Blob()
      • Blob()
      • operator std::string()
      • data()
      • end()
      • size()

• Class CreatorError
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation
    • zim::CreatorError
      • CreatorError()

• Class CreatorStateError
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • zim::CreatorStateError
      • CreatorStateError()

• Class Entry
  • Inheritance Relationships
    • Derived Type
  • Class Documentation
    • zim::Entry
      • Entry()
      • isRedirect()
      • getTitle()
      • getPath()
      • getItem()
      • getRedirect()
      • getRedirectEntry()
      • getRedirectEntryIndex()
      • getIndex()
      • m_file
      • m_idx
      • m_dirent

• Class EntryNotFound
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • zim::EntryNotFound
      • EntryNotFound()

• Class Formatter
  • Class Documentation
    • zim::Formatter
      • Formatter()
      • ~Formatter()
      • operator<<()
      • operator<<()
      • operator std::string()
      • operator<<

• Class IncoherentImplementationError
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • zim::IncoherentImplementationError
      • IncoherentImplementationError()

• Class InvalidEntry
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • zim::InvalidEntry
      • InvalidEntry()

• Class InvalidType
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • zim::InvalidType
      • InvalidType()

• Class Item
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • zim::Item
      • getTitle()
      • getPath()
      • getMimetype()
      • getData()
      • getData()
      • getSize()
      • getDirectAccessInformation()
      • getIndex()

• Class Query
  • Class Documentation
    • zim::Query
      • Query()
      • setQuery()
      • setGeorange()
      • m_query
      • m_geoquery
      • m_latitude
      • m_longitude
      • m_distance

• Class Search
  • Class Documentation
    • zim::Search
      • Search()
      • operator=()
      • ~Search()
      • getResults()
      • getEstimatedMatches()

• Class Searcher
  • Class Documentation
    • zim::Searcher
      • Searcher()
      • Searcher()
      • Searcher()
      • operator=()
      • Searcher()
      • operator=()
      • ~Searcher()
      • addArchive()
      • search()
      • setVerbose()

• Class SearchIterator
  • Class Documentation
    • zim::SearchIterator
      • iterator_category
      • value_type
      • pointer
      • reference
      • SearchIterator()
      • SearchIterator()
      • operator=()
      • SearchIterator()
      • operator=()
      • ~SearchIterator()
      • operator==()
      • operator!=()
      • operator++()
      • operator++()
      • operator--()
      • operator--()
      • getPath()
      • getTitle()
      • getScore()
      • getSnippet()
      • getWordCount()
      • getSize()
      • getFileIndex()
      • getZimId()
      • operator*()
      • operator->()

• Class SearchResultSet
  • Class Documentation
    • zim::SearchResultSet
      • iterator
      • begin()
      • end()
      • size()

• Class SuggestionItem
  • Class Documentation
    • zim::SuggestionItem
      • SuggestionItem()
      • getTitle()
      • getPath()
      • getSnippet()
      • hasSnippet()

• Class SuggestionIterator
  • Class Documentation
    • zim::SuggestionIterator
      • iterator_category
      • value_type
      • pointer
      • reference
      • SuggestionIterator()
      • SuggestionIterator()
      • operator=()
      • SuggestionIterator()
      • operator=()
      • ~SuggestionIterator()
      • operator==()
      • operator!=()
      • operator++()
      • operator++()
      • operator--()
      • operator--()
      • getEntry()
      • operator*()
      • operator->()

• Class SuggestionResultSet
  • Class Documentation
    • zim::SuggestionResultSet
      • iterator
      • begin()
      • end()
      • size()

• Class SuggestionSearch
  • Class Documentation
    • zim::SuggestionSearch
      • SuggestionSearch()
      • operator=()
      • ~SuggestionSearch()
      • getResults()
      • getEstimatedMatches()

• Class SuggestionSearcher
  • Class Documentation
    • zim::SuggestionSearcher
      • SuggestionSearcher()
      • SuggestionSearcher()
      • operator=()
      • SuggestionSearcher()
      • operator=()
      • ~SuggestionSearcher()
      • suggest()
      • setVerbose()

• Class BasicItem
  • Inheritance Relationships
    • Base Type
    • Derived Types
  • Class Documentation
    • zim::writer::BasicItem
      • BasicItem()
      • getPath()
      • getTitle()
      • getMimeType()
      • getHints()
      • path
      • mimetype
      • title
      • hints

• Class ContentProvider
  • Inheritance Relationships
    • Derived Types
  • Class Documentation
    • zim::writer::ContentProvider
      • ~ContentProvider()
      • getSize()
      • feed()

• Class Creator
  • Class Documentation
    • zim::writer::Creator
      • Creator()
      • ~Creator()
      • configVerbose()
      • configCompression()
      • configClusterSize()
      • configIndexing()
      • configNbWorkers()
      • startZimCreation()
      • addItem()
      • addMetadata()
      • addMetadata()
      • addIllustration()
      • addIllustration()
      • addIllustration()
      • addIllustration()
      • addRedirection()
      • addAlias()
      • finishZimCreation()
      • setMainPath()
      • setUuid()

• Class FileItem
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • zim::writer::FileItem
      • FileItem()
      • getContentProvider()
      • filepath

• Class FileProvider
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • zim::writer::FileProvider
      • FileProvider()
      • ~FileProvider()
      • getSize()
      • feed()
      • filepath
      • size

• Class IndexData
  • Class Documentation
    • zim::writer::IndexData
      • GeoPosition
      • ~IndexData()
      • hasIndexData()
      • getTitle()
      • getContent()
      • getKeywords()
      • getWordCount()
      • getGeoPosition()

• Class Item
  • Inheritance Relationships
    • Derived Type
  • Class Documentation
    • zim::writer::Item
      • getPath()
      • getTitle()
      • getMimeType()
      • getContentProvider()
      • getIndexData()
      • getHints()
      • getAmendedHints()
      • ~Item()

• Class SharedStringProvider
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • zim::writer::SharedStringProvider
      • SharedStringProvider()
      • getSize()
      • feed()
      • content
      • feeded

• Class StringItem
  • Inheritance Relationships
    • Base Types
  • Class Documentation
    • zim::writer::StringItem
      • getContentProvider()
      • create()
      • content

• Class StringProvider
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • zim::writer::StringProvider
      • StringProvider()
      • getSize()
      • feed()
      • content
      • feeded

• Class ZimFileFormatError
  • Inheritance Relationships
    • Base Type
  • Class Documentation
    • zim::ZimFileFormatError
      • ZimFileFormatError()

Enums

• Enum Compression
  • Enum Documentation
    • Compression
      • None
      • Zstd

• Enum EntryOrder
  • Enum Documentation
    • EntryOrder
      • pathOrder
      • titleOrder
      • efficientOrder

• Enum IntegrityCheck
  • Enum Documentation
    • IntegrityCheck
      • CHECKSUM
      • DIRENT_PTRS
      • DIRENT_ORDER
      • TITLE_INDEX
      • CLUSTER_PTRS
      • CLUSTERS_OFFSETS
      • DIRENT_MIMETYPES
      • COUNT

• Enum HintKeys
  • Enum Documentation
    • HintKeys
      • COMPRESS
      • FRONT_ARTICLE

Functions

• Template Function zim::_toPathOrder
  • Function Documentation
    • _toPathOrder()

• Specialized Template Function zim::_toPathOrder< EntryOrder::efficientOrder >
  • Function Documentation
    • _toPathOrder< EntryOrder::efficientOrder >()

• Specialized Template Function zim::_toPathOrder< EntryOrder::pathOrder >
  • Function Documentation
    • _toPathOrder< EntryOrder::pathOrder >()

• Specialized Template Function zim::_toPathOrder< EntryOrder::titleOrder >
  • Function Documentation
    • _toPathOrder< EntryOrder::titleOrder >()

• Function zim::getClusterCacheCurrentSize
  • Function Documentation
    • getClusterCacheCurrentSize()

• Function zim::getClusterCacheMaxSize
  • Function Documentation
    • getClusterCacheMaxSize()

• Function zim::getVersions
  • Function Documentation
    • getVersions()

• Function zim::operator<<(std::ostream&, const Blob&)
  • Function Documentation
    • operator<<()

• Function zim::operator<<(std::ostream&, const Uuid&)
  • Function Documentation
    • operator<<()

• Function zim::operator==(const Blob&, const Blob&)
  • Function Documentation
    • operator==()

• Function zim::operator==(const IllustrationInfo&, const IllustrationInfo&)
  • Function Documentation
    • operator==()

• Function zim::printVersions
  • Function Documentation
    • printVersions()

• Function zim::setClusterCacheMaxSize
  • Function Documentation
    • setClusterCacheMaxSize()

• Function zim::validate
  • Function Documentation
    • validate()

Variables

• Variable zim::MimeHtmlTemplate
  • Variable Documentation
    • MimeHtmlTemplate

Defines

• Define DEFAULTFD
  • Define Documentation
    • DEFAULTFD

• Define DEPRECATED
  • Define Documentation
    • DEPRECATED

• Define LIBZIM_API
  • Define Documentation
    • LIBZIM_API

Typedefs

• Typedef zim::blob_index_type
  • Typedef Documentation
    • blob_index_type

• Typedef zim::cluster_index_type
  • Typedef Documentation
    • cluster_index_type

• Typedef zim::entry_index_type
  • Typedef Documentation
    • entry_index_type

• Typedef zim::IntegrityCheckList
  • Typedef Documentation
    • IntegrityCheckList

• Typedef zim::LibVersions
  • Typedef Documentation
    • LibVersions

• Typedef zim::offset_type
  • Typedef Documentation
    • offset_type

• Typedef zim::size_type
  • Typedef Documentation
    • size_type

• Typedef zim::writer::Hints
  • Typedef Documentation
    • Hints