BitArchiveItem Class Reference

The BitArchiveItem class represents a generic item inside an archive. More...

#include <bit7z/bitarchiveitem.hpp>

Inheritance diagram for BitArchiveItem:

Collaboration diagram for BitArchiveItem:

Public Member Functions
auto	attributes () const -> std::uint32_t final
auto	crc () const -> std::uint32_t
auto	creationTime () const -> time_type
auto	extension () const -> tstring
auto	index () const noexcept -> std::uint32_t
auto	isDir () const -> bool final
auto	isEncrypted () const -> bool
auto	isSymLink () const -> bool final
virtual auto	itemProperty (BitProperty property) const -> BitPropVariant=0
	Gets the specified item property.
auto	lastAccessTime () const -> time_type
auto	lastWriteTime () const -> time_type
auto	name () const -> tstring final
auto	nativeName () const -> native_string
auto	nativePath () const -> native_string
auto	packSize () const -> std::uint64_t
auto	path () const -> tstring final
auto	rawPath () const -> sevenzip_string
auto	size () const -> std::uint64_t final

Detailed Description

The BitArchiveItem class represents a generic item inside an archive.

Member Function Documentation

attributes()

auto attributes ( ) const -> std::uint32_t

finalvirtual

Returns

the item attributes.

Implements BitGenericItem.

crc()

auto crc

(

)

const -> std::uint32_t

Returns

the CRC value of the item.

creationTime()

auto creationTime

(

)

const -> time_type

Returns

the item creation time.

extension()

auto extension

(

)

const -> tstring

Returns

the extension of the item, if available or if it can be inferred from the name; otherwise it returns an empty string (e.g., when the item is a folder).

index()

auto index ( ) const -> std::uint32_t

noexcept

Returns

the index of the item in the archive.

isDir()

auto isDir ( ) const -> bool

finalvirtual

Returns

true if and only if the item is a directory (i.e., it has the property BitProperty::IsDir).

Implements BitGenericItem.

isEncrypted()

auto isEncrypted

(

)

const -> bool

Returns

true if and only if the item is encrypted.

isSymLink()

auto isSymLink ( ) const -> bool

finalvirtual

Returns

true if and only if the item is a symbolic link (either has a non-empty BitProperty::SymLink, or it has POSIX/Win32 symbolic link file attributes).

Implements BitGenericItem.

itemProperty()

virtual auto itemProperty ( BitProperty property ) const -> BitPropVariant

pure virtualinherited

Gets the specified item property.

Parameters

property

the property to be retrieved.

Returns

the value of the item property, if available, or an empty BitPropVariant.

Implemented in BitArchiveItemInfo, and BitArchiveItemOffset.

lastAccessTime()

auto lastAccessTime

(

)

const -> time_type

Returns

the item last access time.

lastWriteTime()

auto lastWriteTime

(

)

const -> time_type

Returns

the item last write time.

name()

auto name ( ) const -> tstring

finalvirtual

Returns

the item's name; if not available, it tries to get it from the element's path or, if not possible, it returns an empty string.

Implements BitGenericItem.

nativeName()

auto nativeName

(

)

const -> native_string

Note

Same as name(), but returning a native string (i.e., std::wstring on Windows, std::string elsewhere).

Returns

the name of the item in the archive, if available or inferable from the path, or an empty string otherwise.

nativePath()

auto nativePath

(

)

const -> native_string

Note

Same as path(), but returning a native string (i.e., std::wstring on Windows, std::string elsewhere).

Returns

the path of the item in the archive, if available or inferable from the name, or an empty string otherwise.

packSize()

auto packSize

(

)

const -> std::uint64_t

Returns

the compressed size of the item.

path()

auto path ( ) const -> tstring

finalvirtual

Returns

the path of the item in the archive, if available or inferable from the name, or an empty string otherwise.

Implements BitGenericItem.

rawPath()

auto rawPath

(

)

const -> sevenzip_string

Note

Same as path(), but returning a wide string (the internal string type used by 7-Zip on all OSes).

Returns

the path of the item in the archive, if available or inferable from the name, or an empty string otherwise.

size()

auto size ( ) const -> std::uint64_t

finalvirtual

Returns

the uncompressed size of the item.

Implements BitGenericItem.

---

The documentation for this class was generated from the following file:

• include/bit7z/bitarchiveitem.hpp