File Info Set Iterator API.

File Info Set Iterator API. More...

Files
file	rpmfi.h

Typedefs
typedef rpmFlags	rpmFsmOp

Enumerations
enum	rpmFileActionFlags_e { FAF_UNOWNED = (1U << 31) }

Functions
RPM_PUBLIC_API rpmfi	rpmfiLink (rpmfi fi)
RPM_PUBLIC_API rpm_count_t	rpmfiFC (rpmfi fi)
RPM_PUBLIC_API int	rpmfiFX (rpmfi fi)
RPM_PUBLIC_API int	rpmfiSetFX (rpmfi fi, int fx)
RPM_PUBLIC_API rpm_count_t	rpmfiDC (rpmfi fi)
RPM_PUBLIC_API int	rpmfiDX (rpmfi fi)
RPM_PUBLIC_API const char *	rpmfiBN (rpmfi fi)
RPM_PUBLIC_API const char *	rpmfiDN (rpmfi fi)
RPM_PUBLIC_API const char *	rpmfiFN (rpmfi fi)
RPM_PUBLIC_API int	rpmfiFindFN (rpmfi fi, const char *fn)
RPM_PUBLIC_API const char *	rpmfiOBN (rpmfi fi)
RPM_PUBLIC_API const char *	rpmfiODN (rpmfi fi)
RPM_PUBLIC_API const char *	rpmfiOFN (rpmfi fi)
RPM_PUBLIC_API int	rpmfiFindOFN (rpmfi fi, const char *fn)
RPM_PUBLIC_API rpmfileAttrs	rpmfiFFlags (rpmfi fi)
RPM_PUBLIC_API rpmVerifyAttrs	rpmfiVFlags (rpmfi fi)
RPM_PUBLIC_API rpm_mode_t	rpmfiFMode (rpmfi fi)
RPM_PUBLIC_API rpmfileState	rpmfiFState (rpmfi fi)
RPM_PUBLIC_API int	rpmfiDigestAlgo (rpmfi fi)
RPM_PUBLIC_API const unsigned char *	rpmfiFDigest (rpmfi fi, int *algo, size_t *diglen)
RPM_PUBLIC_API char *	rpmfiFDigestHex (rpmfi fi, int *algo)
RPM_PUBLIC_API const unsigned char *	rpmfiFSignature (rpmfi fi, size_t *siglen)
RPM_PUBLIC_API const unsigned char *	rpmfiVSignature (rpmfi fi, size_t *siglen, uint16_t *algo)
RPM_PUBLIC_API const char *	rpmfiFLink (rpmfi fi)
RPM_PUBLIC_API rpm_loff_t	rpmfiFSize (rpmfi fi)
RPM_PUBLIC_API rpm_rdev_t	rpmfiFRdev (rpmfi fi)
RPM_PUBLIC_API rpm_ino_t	rpmfiFInode (rpmfi fi)
RPM_PUBLIC_API rpm_color_t	rpmfiColor (rpmfi fi)
RPM_PUBLIC_API rpm_color_t	rpmfiFColor (rpmfi fi)
RPM_PUBLIC_API const char *	rpmfiFClass (rpmfi fi)
RPM_PUBLIC_API const char *	rpmfiFMime (rpmfi fi)
uint32_t	rpmfiFDepends (rpmfi fi, const uint32_t **fddictp)
RPM_PUBLIC_API uint32_t	rpmfiFNlink (rpmfi fi)
RPM_PUBLIC_API uint32_t	rpmfiFLinks (rpmfi fi, const int **files)
RPM_PUBLIC_API rpm_time_t	rpmfiFMtime (rpmfi fi)
RPM_PUBLIC_API const char *	rpmfiFUser (rpmfi fi)
RPM_PUBLIC_API const char *	rpmfiFGroup (rpmfi fi)
RPM_PUBLIC_API const char *	rpmfiFCaps (rpmfi fi)
RPM_PUBLIC_API const char *	rpmfiFLangs (rpmfi fi)
RPM_PUBLIC_API int	rpmfiStat (rpmfi fi, int flags, struct stat *sb)
RPM_PUBLIC_API int	rpmfiNext (rpmfi fi)
RPM_PUBLIC_API rpmfi	rpmfiInit (rpmfi fi, int fx)
RPM_PUBLIC_API rpmfi	rpmfiFree (rpmfi fi)
RPM_PUBLIC_API rpmfi	rpmfiNewPool (rpmstrPool pool, Header h, rpmTagVal tagN, rpmfiFlags flags)
RPM_PUBLIC_API rpmfi	rpmfiNew (const rpmts ts, Header h, rpmTagVal tagN, rpmfiFlags flags)
RPM_PUBLIC_API rpmFileTypes	rpmfiWhatis (rpm_mode_t mode)
RPM_PUBLIC_API int	rpmfiCompare (const rpmfi afi, const rpmfi bfi)
RPM_PUBLIC_API rpmVerifyAttrs	rpmfiVerify (rpmfi fi, rpmVerifyAttrs omitMask)
RPM_PUBLIC_API int	rpmfilesStat (rpmfiles fi, int ix, int flags, struct stat *sb)

Detailed Description

File Info Set Iterator API.

Typedef Documentation

rpmFsmOp

typedef rpmFlags rpmFsmOp

File action and associated flags on install/erase

Enumeration Type Documentation

rpmFileActionFlags_e

enum rpmFileActionFlags_e

File disposition flags during package install/erase transaction. XXX: Move these to rpmfi.h once things stabilize.

Function Documentation

rpmfiBN()

RPM_PUBLIC_API const char * rpmfiBN

(

rpmfi

fi

)

Return current base name from file info set iterator.

Parameters

fi	file info set iterator

Returns

current base name, NULL on invalid

rpmfiColor()

RPM_PUBLIC_API rpm_color_t rpmfiColor

(

rpmfi

fi

)

Return union of all file color bits from file info set iterator.

Parameters

fi	file info set iterator

Returns

current color

rpmfiCompare()

RPM_PUBLIC_API int rpmfiCompare	(	const rpmfi	afi,
		const rpmfi	bfi )

Return file info comparison.

Parameters

afi	1st file info
bfi	2nd file info

Returns

0 if identical

rpmfiDC()

RPM_PUBLIC_API rpm_count_t rpmfiDC

(

rpmfi

fi

)

Return directory count from file info set iterator.

Parameters

fi	file info set iterator

Returns

current directory count

rpmfiDigestAlgo()

RPM_PUBLIC_API int rpmfiDigestAlgo

(

rpmfi

fi

)

Return digest algorithm of a file info set iterator.

Parameters

fi	file info set iterator

Returns

digest algorithm of file info set iterator, 0 on invalid

rpmfiDN()

RPM_PUBLIC_API const char * rpmfiDN

(

rpmfi

fi

)

Return current directory name from file info set iterator.

Parameters

fi	file info set iterator

Returns

current directory, NULL on invalid

rpmfiDX()

RPM_PUBLIC_API int rpmfiDX

(

rpmfi

fi

)

Return current directory index from file info set iterator.

Parameters

fi	file info set iterator

Returns

current directory index

rpmfiFC()

RPM_PUBLIC_API rpm_count_t rpmfiFC

(

rpmfi

fi

)

Return file count from file info set iterator.

Parameters

fi	file info set iterator

Returns

current file count

rpmfiFCaps()

RPM_PUBLIC_API const char * rpmfiFCaps

(

rpmfi

fi

)

Return textual representation of current file capabilities from file info set iterator. See cap_from_text(3) for details.

Parameters

fi	file info set iterator

Returns

file capability description, "" for no capabilities and NULL on invalid

rpmfiFClass()

RPM_PUBLIC_API const char * rpmfiFClass

(

rpmfi

fi

)

Return current file class from file info set iterator (v4 packages).

Parameters

fi	file info set iterator

Returns

current file class, 0 on invalid

rpmfiFColor()

RPM_PUBLIC_API rpm_color_t rpmfiFColor

(

rpmfi

fi

)

Return current file color bits from file info set iterator.

Parameters

fi	file info set iterator

Returns

current file color

rpmfiFDepends()

uint32_t rpmfiFDepends	(	rpmfi	fi,
		const uint32_t **	fddictp )

Return current file depends dictionary from file info set iterator.

Parameters

	fi	file info set iterator
[out]	*fddictp	file depends dictionary array (or NULL)

Returns

no. of file depends entries, 0 on invalid

rpmfiFDigest()

RPM_PUBLIC_API const unsigned char * rpmfiFDigest	(	rpmfi	fi,
		int *	algo,
		size_t *	diglen )

Return current file (binary) digest of file info set iterator.

Parameters

	fi	file info set iterator
[out]	algo	digest hash algorithm used (pass NULL to ignore)
[out]	diglen	digest hash length (pass NULL to ignore)

Returns

current file digest, NULL on invalid

rpmfiFDigestHex()

RPM_PUBLIC_API char * rpmfiFDigestHex	(	rpmfi	fi,
		int *	algo )

Return current file (hex) digest of file info set iterator. The file info set iterator stores file digests in binary format to conserve memory, this converts the binary data back to hex presentation used in headers.

Parameters

	fi	file info set iterator
[out]	algo	digest hash algorithm used (pass NULL to ignore)

Returns

current file digest (malloc'ed), NULL on invalid

rpmfiFFlags()

RPM_PUBLIC_API rpmfileAttrs rpmfiFFlags

(

rpmfi

fi

)

Return current file flags from file info set iterator.

Parameters

fi	file info set iterator

Returns

current file flags, 0 on invalid

rpmfiFGroup()

RPM_PUBLIC_API const char * rpmfiFGroup

(

rpmfi

fi

)

Return current file group from file info set iterator.

Parameters

fi	file info set iterator

Returns

current file group, NULL on invalid

rpmfiFindFN()

RPM_PUBLIC_API int rpmfiFindFN	(	rpmfi	fi,
		const char *	fn )

Return file index of the given file name or -1 if file is not in the rpmfi. The file name may have "." prefixed but is then interpreted as a global path without the prefixing "."

Parameters

fi	file info set iterator
fn	file name

Returns

file index or -1

rpmfiFindOFN()

RPM_PUBLIC_API int rpmfiFindOFN	(	rpmfi	fi,
		const char *	fn )

Return file index of the given original file name or -1 if file is not in the rpmfi. The file name may have "." prefixed but is then interpreted as a global path without the prefixing "."

Parameters

fi	file info set iterator
fn	file name

Returns

file index or -1

rpmfiFInode()

RPM_PUBLIC_API rpm_ino_t rpmfiFInode

(

rpmfi

fi

)

Return current file inode from file info set iterator.

Parameters

fi	file info set iterator

Returns

current file inode, 0 on invalid

rpmfiFLangs()

RPM_PUBLIC_API const char * rpmfiFLangs

(

rpmfi

fi

)

Return current file language(s) from file info set iterator.

Parameters

fi	file info set iterator

Returns

current file language(s), NULL on invalid

rpmfiFLink()

RPM_PUBLIC_API const char * rpmfiFLink

(

rpmfi

fi

)

Return current file linkto (i.e. symlink(2) target) from file info set iterator.

Parameters

fi	file info set iterator

Returns

current file linkto, NULL on invalid

rpmfiFLinks()

RPM_PUBLIC_API uint32_t rpmfiFLinks	(	rpmfi	fi,
		const int **	files )

Return (calculated) current file nlink count from file info set iterator.

Parameters

fi	file info set iterator
files	returns array of file ids hardlinked including ix, NULL for nlink count == 1

Returns

current file nlink count, 0 on invalid

rpmfiFMime()

RPM_PUBLIC_API const char * rpmfiFMime

(

rpmfi

fi

)

Return current file mime type from file info set iterator (v6 packages)

Parameters

fi	file info set iterator

Returns

current file mime type, 0 on invalid

rpmfiFMode()

RPM_PUBLIC_API rpm_mode_t rpmfiFMode

(

rpmfi

fi

)

Return current file mode from file info set iterator.

Parameters

fi	file info set iterator

Returns

current file mode, 0 on invalid

rpmfiFMtime()

RPM_PUBLIC_API rpm_time_t rpmfiFMtime

(

rpmfi

fi

)

Return current file modify time from file info set iterator.

Parameters

fi	file info set iterator

Returns

current file modify time, 0 on invalid

rpmfiFN()

RPM_PUBLIC_API const char * rpmfiFN

(

rpmfi

fi

)

Return current file name from file info set iterator. NOTE: the returned pointer is only valid until the next rpmfiFN() call!

Parameters

fi	file info set iterator

Returns

current file name

rpmfiFNlink()

RPM_PUBLIC_API uint32_t rpmfiFNlink

(

rpmfi

fi

)

Return (calculated) current file nlink count from file info set iterator.

Parameters

fi	file info set iterator

Returns

current file nlink count, 0 on invalid

rpmfiFRdev()

RPM_PUBLIC_API rpm_rdev_t rpmfiFRdev

(

rpmfi

fi

)

Return current file rdev from file info set iterator.

Parameters

fi	file info set iterator

Returns

current file rdev, 0 on invalid

rpmfiFree()

RPM_PUBLIC_API rpmfi rpmfiFree

(

rpmfi

fi

)

Destroy a file info set iterator.

Parameters

fi	file info set iterator

Returns

NULL always

rpmfiFSignature()

RPM_PUBLIC_API const unsigned char * rpmfiFSignature	(	rpmfi	fi,
		size_t *	siglen )

Return current file (binary) signature of file info set iterator.

Parameters

	fi	file info set iterator
[out]	siglen	signature length (pass NULL to ignore)

Returns

current file signature, NULL on invalid

rpmfiFSize()

RPM_PUBLIC_API rpm_loff_t rpmfiFSize

(

rpmfi

fi

)

Return current file size from file info set iterator.

Parameters

fi	file info set iterator

Returns

current file size, 0 on invalid

rpmfiFState()

RPM_PUBLIC_API rpmfileState rpmfiFState

(

rpmfi

fi

)

Return current file state from file info set iterator.

Parameters

fi	file info set iterator

Returns

current file state, 0 on invalid

rpmfiFUser()

RPM_PUBLIC_API const char * rpmfiFUser

(

rpmfi

fi

)

Return current file owner from file info set iterator.

Parameters

fi	file info set iterator

Returns

current file owner, NULL on invalid

rpmfiFX()

RPM_PUBLIC_API int rpmfiFX

(

rpmfi

fi

)

Return current file index from file info set iterator.

Parameters

fi	file info set iterator

Returns

current file index

rpmfiInit()

RPM_PUBLIC_API rpmfi rpmfiInit	(	rpmfi	fi,
		int	fx )

Initialize file iterator index.

Parameters

fi	file info set iterator
fx	file iterator index

Returns

file info set iterator

rpmfilesStat()

RPM_PUBLIC_API int rpmfilesStat	(	rpmfiles	fi,
		int	ix,
		int	flags,
		struct stat *	sb )

Map file stat(2) info.

Parameters

	fi	file info set
	ix	file index
	flags	flags
[out]	sb	mapped stat(2) data

Returns

0 on success

rpmfiLink()

RPM_PUBLIC_API rpmfi rpmfiLink

(

rpmfi

fi

)

Reference a file info set iterator instance.

Parameters

fi	file info set iterator

Returns

new file info set iterator reference

rpmfiNew()

RPM_PUBLIC_API rpmfi rpmfiNew	(	const rpmts	ts,
		Header	h,
		rpmTagVal	tagN,
		rpmfiFlags	flags )

Create and load a file info set iterator.

Parameters

ts	unused
h	header
tagN	unused
flags	Flags to control what information is loaded.

Returns

new file info set iterator

rpmfiNewPool()

RPM_PUBLIC_API rpmfi rpmfiNewPool	(	rpmstrPool	pool,
		Header	h,
		rpmTagVal	tagN,
		rpmfiFlags	flags )

Create and load a file info set iterator.

Parameters

pool	shared string pool (or NULL for private pool)
h	header
tagN	unused
flags	Flags to control what information is loaded.

Returns

new file info set iterator

rpmfiNext()

RPM_PUBLIC_API int rpmfiNext

(

rpmfi

fi

)

Return next file iterator index.

Parameters

fi	file info set iterator

Returns

file iterator index, -1 on termination

rpmfiOBN()

RPM_PUBLIC_API const char * rpmfiOBN

(

rpmfi

fi

)

Return current original base name from file info set iterator.

Parameters

fi	file info set iterator

Returns

current base name, NULL on invalid

rpmfiODN()

RPM_PUBLIC_API const char * rpmfiODN

(

rpmfi

fi

)

Return current original directory name from file info set iterator.

Parameters

fi	file info set iterator

Returns

current directory, NULL on invalid

rpmfiOFN()

RPM_PUBLIC_API const char * rpmfiOFN

(

rpmfi

fi

)

Return current original file name from file info set iterator. NOTE: the returned pointer is only valid until the next rpmfiOFN() call!

Parameters

fi	file info set iterator

Returns

current file name

rpmfiSetFX()

RPM_PUBLIC_API int rpmfiSetFX	(	rpmfi	fi,
		int	fx )

Set current file index in file info set iterator.

Parameters

fi	file info set iterator
fx	new file index

Returns

new file index, -1 on error

rpmfiStat()

RPM_PUBLIC_API int rpmfiStat	(	rpmfi	fi,
		int	flags,
		struct stat *	sb )

Map file stat(2) info.

Parameters

	fi	file info iterator
	flags	flags
[out]	sb	mapped stat(2) data

rpmfiVerify()

RPM_PUBLIC_API rpmVerifyAttrs rpmfiVerify	(	rpmfi	fi,
		rpmVerifyAttrs	omitMask )

Verify file attributes (including digest).

Parameters

fi	file info iterator
omitMask	bit(s) to disable verify checks

Returns

bit(s) to indicate failure (ie 0 for passed verify)

rpmfiVFlags()

RPM_PUBLIC_API rpmVerifyAttrs rpmfiVFlags

(

rpmfi

fi

)

Return current file verify flags from file info set iterator.

Parameters

fi	file info set iterator

Returns

current file verify flags, 0 on invalid

rpmfiVSignature()

RPM_PUBLIC_API const unsigned char * rpmfiVSignature	(	rpmfi	fi,
		size_t *	siglen,
		uint16_t *	algo )

Return current verity (binary) signature of file info set iterator.

Parameters

	fi	file info set iterator
[out]	siglen	signature length (pass NULL to ignore)
[out]	algo	fsverity algorithm

Returns

current verity signature, NULL on invalid

rpmfiWhatis()

RPM_PUBLIC_API rpmFileTypes rpmfiWhatis

(

rpm_mode_t

mode

)

Return file type from mode_t.

Parameters

mode	file mode bits (from header)

Returns

file type