BitInputItem Class Reference

A generic input item for compression operations. More...

#include <bit7z/bitinputitem.hpp>

Public Member Functions
auto	attributes () const noexcept -> std::uint32_t
auto	hasNewData () const noexcept -> bool
auto	inArchivePath () const -> const sevenzip_string &
auto	isDir () const noexcept -> bool
auto	isSymLink () const noexcept -> bool
auto	itemProperty (BitProperty property) const -> BitPropVariant
auto	path () const -> const native_string &
void	setCreationTime (time_type creationTime) noexcept
	Sets the creation time of the item.
void	setLastAccessTime (time_type lastAccessTime) noexcept
	Sets the last access time of the item.
void	setLastWriteTime (time_type lastWriteTime) noexcept
	Sets the last write time of the item.
auto	size () const noexcept -> std::uint64_t

Detailed Description

A generic input item for compression operations.

Member Function Documentation

attributes()

auto attributes ( ) const -> std::uint32_t

noexcept

Returns

the filesystem attributes of the item.

hasNewData()

auto hasNewData ( ) const -> bool

noexcept

Returns

true if the item contributes new data to the archive (i.e., it is not merely a renamed entry from an existing archive).

inArchivePath()

auto inArchivePath

(

)

const -> const sevenzip_string &

Returns

the path of the item as it will be stored inside the archive.

isDir()

auto isDir ( ) const -> bool

noexcept

Returns

true if the item represents a directory.

isSymLink()

auto isSymLink ( ) const -> bool

noexcept

Returns

true if the item represents a symbolic link.

itemProperty()

auto itemProperty

(

BitProperty

property

)

const -> BitPropVariant

Parameters

property

the property to retrieve.

Returns

the value of the given property for this item.

path()

auto path

(

)

const -> const native_string &

Returns

the native filesystem path of the item.

setCreationTime()

void setCreationTime ( time_type creationTime )

noexcept

Sets the creation time of the item.

Parameters

creationTime

the creation time to set.

setLastAccessTime()

void setLastAccessTime ( time_type lastAccessTime )

noexcept

Sets the last access time of the item.

Parameters

lastAccessTime

the last access time to set.

setLastWriteTime()

void setLastWriteTime ( time_type lastWriteTime )

noexcept

Sets the last write time of the item.

Parameters

lastWriteTime

the last write time to set.

size()

auto size ( ) const -> std::uint64_t

noexcept

Returns

the uncompressed size of the item, in bytes.

---

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

• include/bit7z/bitinputitem.hpp