Provides easy serialization to XML files (optionally wrapped in ZIP archives). More...

Static Public Member Functions
static T	LoadXml< T > ([NotNull] Stream stream)
	Loads an object from an XML file. More...

static T	LoadXml< T > ([NotNull, Localizable(false)] string path)
	Loads an object from an XML file. More...

static T	FromXmlString< T > ([NotNull, Localizable(false)] string data)
	Loads an object from an XML string. More...

static void	SaveXml< T > ([NotNull] this T data, [NotNull] Stream stream, [CanBeNull, Localizable(false)] string stylesheet=null)
	Saves an object in an XML stream ending with a line break. More...

static void	SaveXml< T > ([NotNull] this T data, [NotNull, Localizable(false)] string path, [CanBeNull, Localizable(false)] string stylesheet=null)
	Saves an object in an XML file ending with a line break. More...

static string	ToXmlString< T > ([NotNull] this T data, [CanBeNull, Localizable(false)] string stylesheet=null)
	Returns an object as an XML string ending with a line break. More...

static T	LoadXmlZip< T > ([NotNull] Stream stream, [CanBeNull, Localizable(false)] string password=null, [NotNull] params EmbeddedFile[] additionalFiles)
	Loads an object from an XML file embedded in a ZIP archive. More...

static T	LoadXmlZip< T > ([NotNull, Localizable(false)] string path, [CanBeNull, Localizable(false)] string password=null, [NotNull] params EmbeddedFile[] additionalFiles)
	Loads an object from an XML file embedded in a ZIP archive. More...

static void	SaveXmlZip< T > ([NotNull] this T data, [NotNull] Stream stream, [CanBeNull, Localizable(false)] string password=null, [NotNull] params EmbeddedFile[] additionalFiles)
	Saves an object in an XML file embedded in a ZIP archive. More...

static void	SaveXmlZip< T > ([NotNull] this T data, [NotNull, Localizable(false)] string path, [CanBeNull, Localizable(false)] string password=null, [NotNull] params EmbeddedFile[] additionalFiles)
	Saves an object in an XML file embedded in a ZIP archive. More...

Public Attributes
const string	XsiNamespace = "http://www.w3.org/2001/XMLSchema-instance"
	The XML namespace used for XML Schema instance. More...

Detailed Description

Provides easy serialization to XML files (optionally wrapped in ZIP archives).

Member Function Documentation

◆ FromXmlString< T >()

static T OmegaEngine.Storage.XmlStorage.FromXmlString< T > ( [NotNull, Localizable(false)] string data )

inlinestatic

Loads an object from an XML string.

Template Parameters

T	The type of object the XML string shall be converted into.

Parameters

data	The XML string to be parsed.

Returns: The loaded object.

Exceptions

InvalidDataException A problem occurred while deserializing the XML data.

◆ LoadXml< T >() [1/2]

static T OmegaEngine.Storage.XmlStorage.LoadXml< T > ( [NotNull] Stream stream )

inlinestatic

Loads an object from an XML file.

Template Parameters

T	The type of object the XML stream shall be converted into.

Parameters

stream The stream to read the encoded XML data from.

Returns: The loaded object.

Exceptions

InvalidDataException A problem occurred while deserializing the XML data.

◆ LoadXml< T >() [2/2]

static T OmegaEngine.Storage.XmlStorage.LoadXml< T > ( [NotNull, Localizable(false)] string path )

inlinestatic

Loads an object from an XML file.

Template Parameters

T	The type of object the XML stream shall be converted into.

Parameters

path	The path of the file to load.

Returns: The loaded object.

Exceptions

IOException	A problem occurred while reading the file.
UnauthorizedAccessException	Read access to the file is not permitted.
InvalidDataException	A problem occurred while deserializing the XML data.

Uses AtomicRead internally.

◆ LoadXmlZip< T >() [1/2]

static T OmegaEngine.Storage.XmlStorage.LoadXmlZip< T >	(	[NotNull] Stream	stream,
		[CanBeNull, Localizable(false)] string	password = `null`,
		[NotNull] params EmbeddedFile []	additionalFiles
	)

inlinestatic

Loads an object from an XML file embedded in a ZIP archive.

Template Parameters

T	The type of object the XML stream shall be converted into.

Parameters

stream	The ZIP archive to load.
password	The password to use for decryption; `null` for no encryption.
additionalFiles	Additional files stored alongside the XML file in the ZIP archive to be read.

Returns: The loaded object.

Exceptions

ZipException	A problem occurred while reading the ZIP data or if password is wrong.
InvalidDataException	A problem occurred while deserializing the XML data.

◆ LoadXmlZip< T >() [2/2]

static T OmegaEngine.Storage.XmlStorage.LoadXmlZip< T >	(	[NotNull, Localizable(false)] string	path,
		[CanBeNull, Localizable(false)] string	password = `null`,
		[NotNull] params EmbeddedFile []	additionalFiles
	)

inlinestatic

Loads an object from an XML file embedded in a ZIP archive.

Template Parameters

T	The type of object the XML stream shall be converted into.

Parameters

path	The ZIP archive to load.
password	The password to use for decryption; `null` for no encryption.
additionalFiles	Additional files stored alongside the XML file in the ZIP archive to be read.

Returns: The loaded object.

Exceptions

IOException	A problem occurred while reading the file.
UnauthorizedAccessException	Read access to the file is not permitted.
ZipException	A problem occurred while reading the ZIP data or if password is wrong.
InvalidDataException	A problem occurred while deserializing the XML data.

Uses AtomicRead internally.

◆ SaveXml< T >() [1/2]

static void OmegaEngine.Storage.XmlStorage.SaveXml< T >	(	[NotNull] this T	data,
		[NotNull] Stream	stream,
		[CanBeNull, Localizable(false)] string	stylesheet = `null`
	)

inlinestatic

Saves an object in an XML stream ending with a line break.

Template Parameters

T	The type of object to be saved in an XML stream.

Parameters

data	The object to be stored.
stream	The stream to write the encoded XML data to.
stylesheet	The path of an XSL stylesheet for T ; can be `null`.

◆ SaveXml< T >() [2/2]

static void OmegaEngine.Storage.XmlStorage.SaveXml< T >	(	[NotNull] this T	data,
		[NotNull, Localizable(false)] string	path,
		[CanBeNull, Localizable(false)] string	stylesheet = `null`
	)

inlinestatic

Saves an object in an XML file ending with a line break.

This method performs an atomic write operation when possible.

Template Parameters

T	The type of object to be saved in an XML stream.

Parameters

data	The object to be stored.
path	The path of the file to write.
stylesheet	The path of an XSL stylesheet for T ; can be `null`.

Exceptions

IOException	A problem occurred while writing the file.
UnauthorizedAccessException	Write access to the file is not permitted.

Uses

See also: AtomicWrite

internally.

◆ SaveXmlZip< T >() [1/2]

static void OmegaEngine.Storage.XmlStorage.SaveXmlZip< T >	(	[NotNull] this T	data,
		[NotNull] Stream	stream,
		[CanBeNull, Localizable(false)] string	password = `null`,
		[NotNull] params EmbeddedFile []	additionalFiles
	)

inlinestatic

Saves an object in an XML file embedded in a ZIP archive.

Template Parameters

T	The type of object to be saved in an XML stream.

Parameters

data	The object to be stored.
stream	The ZIP archive to be written.
password	The password to use for encryption; `null` for no encryption.
additionalFiles	Additional files to be stored alongside the XML file in the ZIP archive; can be `null`.

◆ SaveXmlZip< T >() [2/2]

static void OmegaEngine.Storage.XmlStorage.SaveXmlZip< T >	(	[NotNull] this T	data,
		[NotNull, Localizable(false)] string	path,
		[CanBeNull, Localizable(false)] string	password = `null`,
		[NotNull] params EmbeddedFile []	additionalFiles
	)

inlinestatic

Saves an object in an XML file embedded in a ZIP archive.

Template Parameters

T	The type of object to be saved in an XML stream.

Parameters

data	The object to be stored.
path	The ZIP archive to be written.
password	The password to use for encryption; `null` for no encryption.
additionalFiles	Additional files to be stored alongside the XML file in the ZIP archive; can be `null`.

Exceptions

IOException	A problem occurred while writing the file.
UnauthorizedAccessException	Write access to the file is not permitted.

Uses

See also: AtomicWrite

internally.

◆ ToXmlString< T >()

static string OmegaEngine.Storage.XmlStorage.ToXmlString< T >	(	[NotNull] this T	data,
		[CanBeNull, Localizable(false)] string	stylesheet = `null`
	)

inlinestatic

Returns an object as an XML string ending with a line break.

Template Parameters

T	The type of object to be saved in an XML string.

Parameters

data	The object to be stored.
stylesheet	The path of an XSL stylesheet for T ; can be `null`.

Returns: A string containing the XML code.

Member Data Documentation

◆ XsiNamespace

const string OmegaEngine.Storage.XmlStorage.XsiNamespace = "http://www.w3.org/2001/XMLSchema-instance"

The XML namespace used for XML Schema instance.

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

OmegaEngine/Storage/XmlStorage.cs

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ FromXmlString< T >()

◆ LoadXml< T >() [1/2]

◆ LoadXml< T >() [2/2]

◆ LoadXmlZip< T >() [1/2]

◆ LoadXmlZip< T >() [2/2]

◆ SaveXml< T >() [1/2]

◆ SaveXml< T >() [2/2]

◆ SaveXmlZip< T >() [1/2]

◆ SaveXmlZip< T >() [2/2]

◆ ToXmlString< T >()

Member Data Documentation

◆ XsiNamespace