AgateLib.Utility.TgzFileProvider Class Reference

TgzFileProvider implements IFileProvider and provides read access to gzipped tar archives. This provides basic support for reading files from a compressed archive external to the application. More...

Inheritance diagram for AgateLib.Utility.TgzFileProvider:

List of all members.

Classes
class	FileInfo
Public Member Functions
	TgzFileProvider (string filename)
	Constructs a TgzFileProvider to read from the specified archive.
	TgzFileProvider (string name, byte[] bytes)
	Constructs a TgzFileProvider to read from the specified archive from archive data loaded into a byte array. This overload is useful for a tar.gz file embedded as a resource.
	TgzFileProvider (string name, Stream fileStream)
	Constructs a TgzFileProvider to read from the specified archive.
Stream	OpenRead (string filename)
	Opens the specified file in the archive for reading.
bool	FileExists (string filename)
	Returns true if the specified file exists in the archive.
IEnumerable< string >	GetAllFiles ()
	Enumerates all files in the archive.
IEnumerable< string >	GetAllFiles (string searchPattern)
	Enumerates all files matching the pattern.

---

Detailed Description

TgzFileProvider implements IFileProvider and provides read access to gzipped tar archives. This provides basic support for reading files from a compressed archive external to the application.

---

Constructor & Destructor Documentation

AgateLib.Utility.TgzFileProvider.TgzFileProvider

(

string

filename

)

Constructs a TgzFileProvider to read from the specified archive.

Parameters:

filename

AgateLib.Utility.TgzFileProvider.TgzFileProvider	(	string	name,
		byte[]	bytes
	)

Constructs a TgzFileProvider to read from the specified archive from archive data loaded into a byte array. This overload is useful for a tar.gz file embedded as a resource.

Parameters:

	name
	bytes

AgateLib.Utility.TgzFileProvider.TgzFileProvider	(	string	name,
		Stream	fileStream
	)

Constructs a TgzFileProvider to read from the specified archive.

Parameters:

	name	A name used to identify this stream in debugging information.
	fileStream

---

Member Function Documentation

bool AgateLib.Utility.TgzFileProvider.FileExists

(

string

filename

)

Returns true if the specified file exists in the archive.

Parameters:

filename

Returns:

Implements AgateLib.IFileProvider.

IEnumerable<string> AgateLib.Utility.TgzFileProvider.GetAllFiles

(

string

searchPattern

)

Enumerates all files matching the pattern.

Parameters:

searchPattern

Returns:

Implements AgateLib.IFileProvider.

IEnumerable<string> AgateLib.Utility.TgzFileProvider.GetAllFiles

(

)

Enumerates all files in the archive.

Returns:

Implements AgateLib.IFileProvider.

Stream AgateLib.Utility.TgzFileProvider.OpenRead

(

string

filename

)

Opens the specified file in the archive for reading.

Parameters:

filename

Returns:

Implements AgateLib.IFileProvider.

---

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

• Utility/TgzFileProvider.cs