Namespaces
namespace	Compression

Classes
class	BasicSTDIOStreamWrapper
	Represents a System.IO.Stream-like wrapper for std::basic_iostream and its derived objects. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

class	BasicSTDIStreamWrapper
	Represents a System.IO.Stream-like wrapper for std::basic_istream and its derived objects. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

class	BasicSTDOStreamWrapper
	Represents a System.IO.Stream-like wrapper for std::basic_ostream and its derived objects. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

class	BasicSystemIOStreamBuf
	Represents a buffer that wraps System::IO::Stream-like streams and allows them to be used as an std::iostream-like streams internal buffer. More...

class	BasicSystemIOStreamWrapper
	Represents a std::iostream-like wrapper that used BasicSystemIOStreamBuf as internal buffer. More...

class	BasicSystemIStreamWrapper
	Represents a std::istream-like wrapper that used BasicSystemIOStreamBuf as internal buffer. More...

class	BasicSystemOStreamWrapper
	Represents a std::ostream-like wrapper that used BasicSystemIOStreamBuf as internal buffer. More...

class	BinaryReader
	Represents a reader that reads primitive data types as binary data in particular encoding. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

class	BinaryWriter
	Represents a writer that writes values of primitive types to a byte stream. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

class	BufferedStream
	Adds a buffering layer on top of another stream. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

class	Details_FileNotFoundException
	The exception that is thrown when an attempt to access a file that does not exist on disk fails. Never create instances of this class manually. Use the FileNotFoundException class instead. Never wrap the FileNotFoundException class instances into System::SmartPtr.

class	Directory
	Contains methods for manipulating directories. This is a static type with no instance services. You should never create instances of it by any means. More...

class	DirectoryInfo
	Represents a file system path, a directory referred to by this path and provides instance methods for manipulating directories. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

class	File
	Provides methods for manipulating files. This is a static type with no instance services. You should never create instances of it by any means. More...

class	FileInfo
	Represents a path to a file and a file referred to by this path and provides methods for manipulating it. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

class	FileStream
	Represents a file stream supporting synchronous and asynchronous read and write operations. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

class	FileSystemInfo
	The base class for FileInfo and DirectoryInfo. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

class	FileSystemInfoStat
	Represents information about a file or directory. More...

class	MemoryStream
	Represents a stream that reads from and writes to memory. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

class	Path
	Provides methods for manipulating paths. This is a static type with no instance services. You should never create instances of it by any means. More...

class	STDIOStreamWrapperBase
	Represents a base class for System.IO.Stream-like wrappers. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

class	Stream
	A base class for a variety of stream implementations. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

class	StreamReader
	Represents a reader that reads characters from a byte stream. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

class	StreamWriter
	Represents a writer that writes characters to a byte stream. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

class	StringReader
	Represents a reader that reads characters from a string. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

class	StringWriter
	Implements a TextWriter that writes information to a string. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

class	TextReader
	A base class for classes that represent readers that read sequences of characters from different sources. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

class	TextWriter
	A base class for classes that represent writers that writes sequences of characters to different destinations. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

class	UnmanagedMemoryStream
	Provides access to unmanaged memory. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

Typedefs
typedef SharedPtr< BinaryWriter >	BinaryWriterPtr
	An alias for a shared pointer to this class.

using	FileNotFoundException = System::ExceptionWrapper<Details_FileNotFoundException>
	The exception that is thrown when an attempt to access a file that does not exist on disk fails. Never wrap the FileNotFoundException class instances into System::SmartPtr.

using	STDIStreamWrapper = BasicSTDIStreamWrapper<std::istream>
	Specializations of BasicSTDIStreamWrapper for char character types.

using	STDWIStreamWrapper = BasicSTDIStreamWrapper<std::wistream>
	Specializations of BasicSTDIStreamWrapper for wchar_t character types.

using	STDOStreamWrapper = BasicSTDOStreamWrapper<std::ostream>
	Specializations of BasicSTDOStreamWrapper for char character types.

using	STDWOStreamWrapper = BasicSTDOStreamWrapper<std::wostream>
	Specializations of BasicSTDOStreamWrapper for wchar_t character types.

using	STDIOStreamWrapper = BasicSTDIOStreamWrapper<std::iostream>
	Specializations of BasicSTDIOStreamWrapper for char character types.

using	STDWIOStreamWrapper = BasicSTDIOStreamWrapper<std::wiostream>
	Specializations of BasicSTDIOStreamWrapper for wchar_t character types.

using	SystemIStreamWrapper = BasicSystemIStreamWrapper<char, std::char_traits<char>>
	Specializations of BasicSystemIStreamWrapper for char character types.

using	SystemWIStreamWrapper = BasicSystemIStreamWrapper<wchar_t, std::char_traits<wchar_t>>
	Specializations of BasicSystemIStreamWrapper for wchar_t character types.

using	SystemOStreamWrapper = BasicSystemOStreamWrapper<char, std::char_traits<char>>
	Specializations of BasicSystemOStreamWrapper for char character types.

using	SystemWOStreamWrapper = BasicSystemOStreamWrapper<wchar_t, std::char_traits<wchar_t>>
	Specializations of BasicSystemOStreamWrapper for wchar_t character types.

using	SystemIOStreamWrapper = BasicSystemIOStreamWrapper<char, std::char_traits<char>>
	Specializations of BasicSystemIOStreamWrapper for char character types.

using	SystemWIOStreamWrapper = BasicSystemIOStreamWrapper<wchar_t, std::char_traits<wchar_t>>
	Specializations of BasicSystemIOStreamWrapper for wchar_t character types.

Enumerations
enum class	FileAccess
	Specifies the type of access when opening the file. More...

enum class	FileAttributes
	Represents attributes of a directory or a file. More...

enum class	FileMode
	Specifies how a file should be opened. More...

enum class	FileOptions
	Represents advanced options for creating FileStream object. More...

enum class	FileShare
	Specifies what kind of access other FileStream objects can have to a file being opened. More...

enum class	SearchOption
	Specifies a search should be performed only in the current directory, or in the current directory and all its subdirectories. More...

enum class	SeekOrigin
	Specifies the reference position in the stream relative to which the position to seek to is specified. More...

enum class	STDIOStreamWrappingMode
	Specifies the mode of I/O operations that wrappers will perform on std::iostreams-like streams. More...

enum class	STDIOStreamPositionPreference
	Determines which position in the stream is preferable as a common read and write position when std::basic_iostream and its descendants will have different read and write positions at the time of wrapper creation. More...

enum class	SystemIOStreamWrappingMode
	Specifies the mode of I/O operations that wrappers will perform on System::IO::Stream-like streams. More...

Functions
template<typename char_type , typename traits_type >
SharedPtr< Stream >	WrapSTDIOStream (std::basic_istream< char_type, traits_type > &stream, STDIOStreamWrappingMode mode=STDIOStreamWrappingMode::Binary)
	Wrapper function for std::basic_istream-like streams.

template<typename char_type , typename traits_type >
SharedPtr< Stream >	WrapSTDIOStream (std::basic_ostream< char_type, traits_type > &stream, STDIOStreamWrappingMode mode=STDIOStreamWrappingMode::Binary)
	Wrapper function for std::basic_ostream-like streams.

template<typename char_type , typename traits_type >
SharedPtr< Stream >	WrapSTDIOStream (std::basic_iostream< char_type, traits_type > &stream, STDIOStreamWrappingMode mode=STDIOStreamWrappingMode::Binary, STDIOStreamPositionPreference pref_pos=STDIOStreamPositionPreference::Zero)
	Wrapper function for std::basic_iostream-like streams.

Typedef Documentation

◆ BinaryWriterPtr

typedef SharedPtr<BinaryWriter> System::IO::BinaryWriterPtr

An alias for a shared pointer to this class.

◆ FileNotFoundException

using System::IO::FileNotFoundException = System::ExceptionWrapper<Details_FileNotFoundException>

The exception that is thrown when an attempt to access a file that does not exist on disk fails. Never wrap the FileNotFoundException class instances into System::SmartPtr.

◆ STDIOStreamWrapper

using System::IO::STDIOStreamWrapper = BasicSTDIOStreamWrapper<std::iostream>

Specializations of BasicSTDIOStreamWrapper for char character types.

◆ STDIStreamWrapper

using System::IO::STDIStreamWrapper = BasicSTDIStreamWrapper<std::istream>

Specializations of BasicSTDIStreamWrapper for char character types.

◆ STDOStreamWrapper

using System::IO::STDOStreamWrapper = BasicSTDOStreamWrapper<std::ostream>

Specializations of BasicSTDOStreamWrapper for char character types.

◆ STDWIOStreamWrapper

using System::IO::STDWIOStreamWrapper = BasicSTDIOStreamWrapper<std::wiostream>

Specializations of BasicSTDIOStreamWrapper for wchar_t character types.

◆ STDWIStreamWrapper

using System::IO::STDWIStreamWrapper = BasicSTDIStreamWrapper<std::wistream>

Specializations of BasicSTDIStreamWrapper for wchar_t character types.

◆ STDWOStreamWrapper

using System::IO::STDWOStreamWrapper = BasicSTDOStreamWrapper<std::wostream>

Specializations of BasicSTDOStreamWrapper for wchar_t character types.

◆ SystemIOStreamWrapper

using System::IO::SystemIOStreamWrapper = BasicSystemIOStreamWrapper<char, std::char_traits<char>>

Specializations of BasicSystemIOStreamWrapper for char character types.

◆ SystemIStreamWrapper

using System::IO::SystemIStreamWrapper = BasicSystemIStreamWrapper<char, std::char_traits<char>>

Specializations of BasicSystemIStreamWrapper for char character types.

◆ SystemOStreamWrapper

using System::IO::SystemOStreamWrapper = BasicSystemOStreamWrapper<char, std::char_traits<char>>

Specializations of BasicSystemOStreamWrapper for char character types.

◆ SystemWIOStreamWrapper

using System::IO::SystemWIOStreamWrapper = BasicSystemIOStreamWrapper<wchar_t, std::char_traits<wchar_t>>

Specializations of BasicSystemIOStreamWrapper for wchar_t character types.

◆ SystemWIStreamWrapper

using System::IO::SystemWIStreamWrapper = BasicSystemIStreamWrapper<wchar_t, std::char_traits<wchar_t>>

Specializations of BasicSystemIStreamWrapper for wchar_t character types.

◆ SystemWOStreamWrapper

using System::IO::SystemWOStreamWrapper = BasicSystemOStreamWrapper<wchar_t, std::char_traits<wchar_t>>

Specializations of BasicSystemOStreamWrapper for wchar_t character types.

Enumeration Type Documentation

◆ FileAccess

enum class System::IO::FileAccess

strong

Specifies the type of access when opening the file.

Enumerator
Read	Read-only access.
Write	Write-only access.
ReadWrite	Read and write access.

◆ FileAttributes

enum class System::IO::FileAttributes

strong

Represents attributes of a directory or a file.

Enumerator
Archive	The filesystem entity is a candidate for removal or backup.
Compressed	The filesystem entity is compressed.
Device	Not used.
Directory	The filesystem entity is a directory.
Encrypted	The filesystem entity is encrypted.
Hidden	The filesystem entity is hidden.
IntegrityStream	The filesystem entity contains data integrity support.
Normal	The filesystem entity is a file that has no special attributes.
NotContentIndexed	The filesystem entity will not be indexed by the content indexing service.
NoScrubData	The filesystem entity is not included in the data integrity scan.
Offline	The filesystem entity is offline and its data is not immediately available.
ReadOnly	The filesystem entity is read-only.
ReparsePoint	The filesystem entity is a file that contains a reparse point.
SparseFile	The filesystem entity is a sparse file.
System	The filesystem entity is a system file.
Temporary	The filesystem entity is a temporary file.
Invalid	Invalid value.

◆ FileMode

enum class System::IO::FileMode

strong

Specifies how a file should be opened.

Enumerator
CreateNew	Create a new file. If the file already exists, an exception is thrown.
Create	Create a new file. If the file already exists, it is overwritten.
Open	Open an existing file. If the file does not exist, an exception is thrown.
OpenOrCreate	Open an existing file or create a new one if it does not exist.
Truncate	Open an existing file and truncate it so that it is empty. If the file does not exist, an exception is thrown.
Append	Open an existing file and seek to the end of it or create a new one if it does not exist.

◆ FileOptions

enum class System::IO::FileOptions

strong

Represents advanced options for creating FileStream object.

Enumerator
None	No additional options.
Encrypted	The file is encrypted. NOT IMPLEMENTED.
DeleteOnClose	The file should be automatically deleted when it is not in use anymore.
SequentialScan	The file shoud be accesses sequentially.
RandomAccess	The file is accessed randomly.
Asynchronous	The file can be used for asynchronous I/O operations. NOT IMPLEMENTED.
WriteThrough	All writes should go directly to the disk bypassing any intermediate cache.

◆ FileShare

enum class System::IO::FileShare

strong

Specifies what kind of access other FileStream objects can have to a file being opened.

Enumerator
None	No access.
Read	Read-only access.
Write	Write-only access.
ReadWrite	Read and Write access.
Delete	The file can be deleted.
Inheritable	Makes file handle inheritable by child processes.

◆ SearchOption

enum class System::IO::SearchOption

strong

Specifies a search should be performed only in the current directory, or in the current directory and all its subdirectories.

Enumerator
AllDirectories	Search in the current directory and all its subdirectories.
TopDirectoryOnly	Search in the current directory only.

◆ SeekOrigin

enum class System::IO::SeekOrigin

strong

Specifies the reference position in the stream relative to which the position to seek to is specified.

Enumerator
Begin	Beginning of the stream.
Current	Current stream position.
End	End of the stream.

◆ STDIOStreamPositionPreference

enum class System::IO::STDIOStreamPositionPreference

strong

Determines which position in the stream is preferable as a common read and write position when std::basic_iostream and its descendants will have different read and write positions at the time of wrapper creation.

Enumerator
Zero	Zero position will sets as a read and write position.
ReadPosition	gptr position will sets as a read and write position.
WritePosition	pptr position will sets as a read and write position.

◆ STDIOStreamWrappingMode

enum class System::IO::STDIOStreamWrappingMode

strong

Specifies the mode of I/O operations that wrappers will perform on std::iostreams-like streams.

Enumerator
Binary	A mode that allows input operations to decode stream data of char_type type into bytes, and encode bytes into char_type data for output operations.
Conversion	A mode that allows input operations to convert stream data from char_type type to uint8_t type and vice versa for output operations.

◆ SystemIOStreamWrappingMode

enum class System::IO::SystemIOStreamWrappingMode

strong

Specifies the mode of I/O operations that wrappers will perform on System::IO::Stream-like streams.

Enumerator
Binary	A mode that allows input operations to encode stream bytes into char_type data and decode char_type data into stream bytes for output operations.
Conversion	A mode that allows input operations to convert stream bytes from uint8_t type to char_type type and vice versa for output operations.

Function Documentation

◆ WrapSTDIOStream() [1/3]

template<typename char_type , typename traits_type >

SharedPtr< Stream > System::IO::WrapSTDIOStream	(	std::basic_iostream< char_type, traits_type > &	stream,
		STDIOStreamWrappingMode	mode = STDIOStreamWrappingMode::Binary,
		STDIOStreamPositionPreference	pref_pos = STDIOStreamPositionPreference::Zero )

Wrapper function for std::basic_iostream-like streams.

Parameters

stream	std::basic_iostream-like stream
mode	Wrapping mode
pref_pos	Position that will prefer as read and write position, if they are different

Returns: BasicSTDIOStreamWrapper wrapper

◆ WrapSTDIOStream() [2/3]

template<typename char_type , typename traits_type >

SharedPtr< Stream > System::IO::WrapSTDIOStream	(	std::basic_istream< char_type, traits_type > &	stream,
		STDIOStreamWrappingMode	mode = STDIOStreamWrappingMode::Binary )

Wrapper function for std::basic_istream-like streams.

Parameters

stream	std::basic_istream-like stream
mode	Wrapping mode

Returns: BasicSTDIStreamWrapper wrapper

◆ WrapSTDIOStream() [3/3]

template<typename char_type , typename traits_type >

SharedPtr< Stream > System::IO::WrapSTDIOStream	(	std::basic_ostream< char_type, traits_type > &	stream,
		STDIOStreamWrappingMode	mode = STDIOStreamWrappingMode::Binary )

Wrapper function for std::basic_ostream-like streams.

Parameters

stream	std::basic_ostream-like stream
mode	Wrapping mode

Returns: BasicSTDOStreamWrapper wrapper

Namespaces

Classes

Typedefs

Enumerations

Functions

Typedef Documentation

◆ BinaryWriterPtr

◆ FileNotFoundException

◆ STDIOStreamWrapper

◆ STDIStreamWrapper

◆ STDOStreamWrapper

◆ STDWIOStreamWrapper

◆ STDWIStreamWrapper

◆ STDWOStreamWrapper

◆ SystemIOStreamWrapper

◆ SystemIStreamWrapper

◆ SystemOStreamWrapper

◆ SystemWIOStreamWrapper

◆ SystemWIStreamWrapper

◆ SystemWOStreamWrapper

Enumeration Type Documentation

◆ FileAccess

◆ FileAttributes

◆ FileMode

◆ FileOptions

◆ FileShare

◆ SearchOption

◆ SeekOrigin

◆ STDIOStreamPositionPreference

◆ STDIOStreamWrappingMode

◆ SystemIOStreamWrappingMode

Function Documentation

◆ WrapSTDIOStream() [1/3]

◆ WrapSTDIOStream() [2/3]

◆ WrapSTDIOStream() [3/3]