OmegaEngine API  1.0.3
Public Member Functions | Properties | List of all members
OmegaEngine.Storage.EmbeddedFile Struct Reference

Information about an additional file to be stored along side an ZIP archive using NanoByte.Common.Storage.XmlStorage or BinaryStorage. More...

Public Member Functions

 EmbeddedFile ([NotNull] string filename, [NotNull] Action< Stream > readDelegate)
 Creates a new XML ZIP entry for reading More...
 
 EmbeddedFile ([NotNull] string filename, int compressionLevel, [NotNull] Action< Stream > writeDelegate)
 Creates a new XML ZIP entry for writing More...
 

Properties

string Filename [get]
 The filename in the archive More...
 
int CompressionLevel [get]
 The level of compression (0-9) to apply to this entry More...
 
Action< Stream > StreamDelegate [get]
 The delegate to be called when the data is ready to be read/written to/form a stream More...
 

Detailed Description

Information about an additional file to be stored along side an ZIP archive using NanoByte.Common.Storage.XmlStorage or BinaryStorage.

Constructor & Destructor Documentation

◆ EmbeddedFile() [1/2]

OmegaEngine.Storage.EmbeddedFile.EmbeddedFile ( [NotNull] string  filename,
[NotNull] Action< Stream >  readDelegate 
)
inline

Creates a new XML ZIP entry for reading

Parameters
filenameThe filename in the archive
readDelegateThe delegate to be called when the data is ready to be read

◆ EmbeddedFile() [2/2]

OmegaEngine.Storage.EmbeddedFile.EmbeddedFile ( [NotNull] string  filename,
int  compressionLevel,
[NotNull] Action< Stream >  writeDelegate 
)
inline

Creates a new XML ZIP entry for writing

Parameters
filenameThe filename in the archive
compressionLevelThe level of compression (0-9) to apply to this entry
writeDelegateThe delegate to be called when the data is ready to be written

Property Documentation

◆ CompressionLevel

int OmegaEngine.Storage.EmbeddedFile.CompressionLevel
get

The level of compression (0-9) to apply to this entry

◆ Filename

string OmegaEngine.Storage.EmbeddedFile.Filename
get

The filename in the archive

◆ StreamDelegate

Action<Stream> OmegaEngine.Storage.EmbeddedFile.StreamDelegate
get

The delegate to be called when the data is ready to be read/written to/form a stream


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