Description:

template<typename TNString = NString, typename TAllocator = TEXTFILE_DEFAULT_ALLOCATOR, size_t TLocalBufferSize = 1024>
class alib::system::TTextFile< TNString, TAllocator, TLocalBufferSize >

A rather simple text file reader and writer.

See also: Reading is performed using the helper type TextFileLineReader, which can be used as a standalone helper, i.e. in cases where a text file is read but does not need to be stored in a vector.

Template Parameters

TNString	The string-type. This may also be a type derived from alib::NString which contains further fields available with each line of the file.
TAllocator	The allocator type to use. In the presence of module ALib Monomem, this defaults to MonoAllocator, and to HeapAllocator otherwise.
TLocalBufferSize	The size of the local buffer. If lines are wider and the local buffer is exceeded, it will be replaced by an heap-allocated buffer, which is then reused for any further line. Defaults to 1024.

Definition at line 94 of file textfile.hpp.

#include <textfile.hpp>

Inheritance diagram for alib::system::TTextFile< TNString, TAllocator, TLocalBufferSize >:

[legend]

Collaboration diagram for alib::system::TTextFile< TNString, TAllocator, TLocalBufferSize >:

[legend]

Public Type Index:
using	AllocatorType = TAllocator
	Type definition publishing template parameter TAllocator.
using	StoredType = TNString
using	Vector = std::vector<TNString, lang::StdAllocator<TNString, TEXTFILE_DEFAULT_ALLOCATOR>>
	Type definition publishing the base container type.
Public Type Index: inherited from alib::lang::AllocatorMember< TEXTFILE_DEFAULT_ALLOCATOR >
using	AllocatorType
	Exposes the allocator type.

Public Method Index:
	TTextFile (AllocatorType &ma)
template<typename TIntegral>
constexpr const StoredType &	At (TIntegral idx) const noexcept
template<typename TIntegral>
constexpr StoredType &	At (TIntegral idx) noexcept
std::errc	Read (const CPathString &filePath)
constexpr integer	Size () const noexcept
std::errc	Write (const PathString &filePath)
Public Method Index: inherited from alib::lang::AllocatorMember< TEXTFILE_DEFAULT_ALLOCATOR >
	AllocatorMember ()
AllocatorInterface< TEXTFILE_DEFAULT_ALLOCATOR >	AIF () const noexcept
TEXTFILE_DEFAULT_ALLOCATOR &	GetAllocator () const noexcept

Protected Type Index:
using	base = lang::AllocatorMember<TAllocator>
	The allocator member base-type.

Additional Inherited Members
Protected Field Index: inherited from alib::lang::AllocatorMember< TEXTFILE_DEFAULT_ALLOCATOR >
TEXTFILE_DEFAULT_ALLOCATOR *	allocator
	The allocator stored.

Type Definition Details:

◆ AllocatorType

template<typename TNString = NString, typename TAllocator = TEXTFILE_DEFAULT_ALLOCATOR, size_t TLocalBufferSize = 1024>

using alib::system::TTextFile< TNString, TAllocator, TLocalBufferSize >::AllocatorType = TAllocator

Type definition publishing template parameter TAllocator.

Definition at line 101 of file textfile.hpp.

◆ base

template<typename TNString = NString, typename TAllocator = TEXTFILE_DEFAULT_ALLOCATOR, size_t TLocalBufferSize = 1024>

using alib::system::TTextFile< TNString, TAllocator, TLocalBufferSize >::base = lang::AllocatorMember<TAllocator>

protected

The allocator member base-type.

Definition at line 98 of file textfile.hpp.

◆ StoredType

template<typename TNString = NString, typename TAllocator = TEXTFILE_DEFAULT_ALLOCATOR, size_t TLocalBufferSize = 1024>

using alib::system::TTextFile< TNString, TAllocator, TLocalBufferSize >::StoredType = TNString

Type definition publishing the type in the std::vector that this type is derived of. (As is defined with template parameter TNString.)

Definition at line 106 of file textfile.hpp.

◆ Vector

template<typename TNString = NString, typename TAllocator = TEXTFILE_DEFAULT_ALLOCATOR, size_t TLocalBufferSize = 1024>

using alib::system::TTextFile< TNString, TAllocator, TLocalBufferSize >::Vector = std::vector<TNString, lang::StdAllocator<TNString, TEXTFILE_DEFAULT_ALLOCATOR>>

Type definition publishing the base container type.

Definition at line 109 of file textfile.hpp.

Constructor(s) / Destructor Details:

◆ TTextFile()

template<typename TNString = NString, typename TAllocator = TEXTFILE_DEFAULT_ALLOCATOR, size_t TLocalBufferSize = 1024>

alib::system::TTextFile< TNString, TAllocator, TLocalBufferSize >::TTextFile ( AllocatorType & ma )

inline

Constructor.

Parameters

ma	The allocator to use.

Definition at line 113 of file textfile.hpp.

Method Details:

◆ At() [1/2]

template<typename TNString = NString, typename TAllocator = TEXTFILE_DEFAULT_ALLOCATOR, size_t TLocalBufferSize = 1024>

template<typename TIntegral>

const StoredType & alib::system::TTextFile< TNString, TAllocator, TLocalBufferSize >::At ( TIntegral idx ) const

inlinenodiscardconstexprnoexcept

const-version of At.

Template Parameters

TIntegral The integral type that the index is provided by.

Parameters

idx	The index to retrieve an element for.

Returns: A const reference to the element stored at the given idx.

Definition at line 139 of file textfile.hpp.

◆ At() [2/2]

template<typename TNString = NString, typename TAllocator = TEXTFILE_DEFAULT_ALLOCATOR, size_t TLocalBufferSize = 1024>

template<typename TIntegral>

StoredType & alib::system::TTextFile< TNString, TAllocator, TLocalBufferSize >::At ( TIntegral idx )

inlinenodiscardconstexprnoexcept

Returns the element in the vector at the given position.
Note that this is the same as calling inherited std::vector::at(), but this method accepts any integral type for parameter idx.
Furthermore, this method raises an ALib Assertion in debug-builds, instead of throwing an exception.

Template Parameters

TIntegral The integral type that the index is provided by.

Parameters

idx	The index to retrieve an element for.

Returns: A reference to the element stored at the given idx.

Definition at line 131 of file textfile.hpp.

◆ Read()

template<typename TNString = NString, typename TAllocator = TEXTFILE_DEFAULT_ALLOCATOR, size_t TLocalBufferSize = 1024>

std::errc alib::system::TTextFile< TNString, TAllocator, TLocalBufferSize >::Read ( const CPathString & filePath )

inline

Reads the file into this vector of lines.

Parameters

filePath The path of the file.

Returns: std::errc(0) if all went well, otherwise an error code.

Definition at line 144 of file textfile.hpp.

◆ Size()

template<typename TNString = NString, typename TAllocator = TEXTFILE_DEFAULT_ALLOCATOR, size_t TLocalBufferSize = 1024>

integer alib::system::TTextFile< TNString, TAllocator, TLocalBufferSize >::Size ( ) const

inlineconstexprnoexcept

Returns the vector's size as ALib's signed integral type.

Returns: The number of lines in this source file.

Definition at line 119 of file textfile.hpp.

◆ Write()

template<typename TNString = NString, typename TAllocator = TEXTFILE_DEFAULT_ALLOCATOR, size_t TLocalBufferSize = 1024>

std::errc alib::system::TTextFile< TNString, TAllocator, TLocalBufferSize >::Write ( const PathString & filePath )

inline

Writes this text file to the given filePath.

Parameters

filePath The path of the file.

Returns: std::errc(0) if all went well, otherwise an error code.

Definition at line 168 of file textfile.hpp.

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

textfile.hpp

Description:

Public Type Index:

Public Method Index:

Protected Type Index:

Additional Inherited Members

Type Definition Details:

◆ AllocatorType

◆ base

◆ StoredType

◆ Vector

Constructor(s) / Destructor Details:

◆ TTextFile()

Method Details:

◆ At() [1/2]

◆ At() [2/2]

◆ Read()

◆ Size()

◆ Write()