書き込み用テキストファイル More...

#include <TextWriter.hpp>

Public Member Functions
SIV3D_NODISCARD_CXX20	TextWriter ()
	デフォルトコンストラクタ More...

SIV3D_NODISCARD_CXX20	TextWriter (FilePathView path, TextEncoding encoding)
	テキストファイルをオープンします。 More...

SIV3D_NODISCARD_CXX20	TextWriter (FilePathView path, OpenMode openMode=OpenMode::Trunc, TextEncoding encoding=TextEncoding::UTF8_WITH_BOM)
	テキストファイルをオープンします。 More...

bool	open (FilePathView path, TextEncoding encoding)
	テキストファイルをオープンします。 More...

bool	open (FilePathView path, OpenMode openMode=OpenMode::Trunc, TextEncoding encoding=TextEncoding::UTF8_WITH_BOM)
	テキストファイルをオープンします。 More...

void	close ()
	テキストファイルをクローズします。 More...

bool	isOpen () const noexcept
	テキストファイルがオープンされているかを返します。 More...

	operator bool () const noexcept
	テキストファイルがオープンされているかを返します。 More...

void	clear ()
	現在開いているファイルの内容を消去し、書き込み位置を先頭に戻します。 More...

void	write (char ch)=delete
	ファイルに文字を書き込みます。 More...

void	write (char32 ch)
	ファイルに文字を書き込みます。 More...

void	write (const char32 *s)
	ファイルに文字列を書き込みます。 More...

void	write (StringView s)
	ファイルに文字列を書き込みます。 More...

void	write (const String &s)
	ファイルに文字列を書き込みます。 More...

SIV3D_CONCEPT_FORMATTABLE_ARGS void	write (const Args &... args)
	データを文字列に変換してファイルに書き込みます。 More...

void	writeln (char ch)=delete

void	writeln (char32 ch)
	ファイルに文字を書き込み、改行します。 More...

void	writeln (const char32 *s)
	ファイルに文字列を書き込み、改行します。 More...

void	writeln (StringView s)
	ファイルに文字列を書き込み、改行します。 More...

void	writeln (const String &s)
	ファイルに文字列を書き込み、改行します。 More...

SIV3D_CONCEPT_FORMATTABLE_ARGS void	writeln (const Args &... args)
	データを文字列に変換してファイルに書き込み、改行します。 More...

void	writeUTF8 (std::string_view s)
	ファイルに UTF-8 文字列を書き込みます。 More...

void	writelnUTF8 (std::string_view s)
	ファイルに UTF-8 文字列を書き込み、改行します。 More...

SIV3D_CONCEPT_FORMATTABLE detail::TextWriterBuffer	operator<< (const Formattable &value)
	データを文字列に変換してファイルに書き込み、一連の `<<` が終わったあとに改行します。 More...

TextEncoding	encoding () const noexcept
	テキストのエンコーディング形式を返します。 More...

const FilePath &	path () const noexcept
	オープンしているファイルのフルパスを返します。 More...

Detailed Description

書き込み用テキストファイル

Constructor & Destructor Documentation

◆ TextWriter() [1/3]

SIV3D_NODISCARD_CXX20 s3d::TextWriter::TextWriter ( )

デフォルトコンストラクタ

◆ TextWriter() [2/3]

SIV3D_NODISCARD_CXX20 s3d::TextWriter::TextWriter	(	FilePathView	path,
		TextEncoding	encoding
	)

テキストファイルをオープンします。

Parameters

path	ファイルパス
encoding	テキストのエンコーディング形式

◆ TextWriter() [3/3]

SIV3D_NODISCARD_CXX20 s3d::TextWriter::TextWriter	(	FilePathView	path,
		OpenMode	openMode = `OpenMode::Trunc`,
		TextEncoding	encoding = `TextEncoding::UTF8_WITH_BOM`
	)

explicit

テキストファイルをオープンします。

Parameters

path	ファイルパス
openMode	ファイルのオープンモード
encoding	テキストのエンコーディング形式

Member Function Documentation

◆ clear()

void s3d::TextWriter::clear ( )

現在開いているファイルの内容を消去し、書き込み位置を先頭に戻します。

◆ close()

void s3d::TextWriter::close ( )

テキストファイルをクローズします。

◆ encoding()

TextEncoding s3d::TextWriter::encoding ( ) const

noexcept

テキストのエンコーディング形式を返します。

Returns: テキストのエンコーディング形式

◆ isOpen()

bool s3d::TextWriter::isOpen ( ) const

noexcept

テキストファイルがオープンされているかを返します。

Returns: ファイルがオープンされている場合 true, それ以外の場合は false

◆ open() [1/2]

bool s3d::TextWriter::open	(	FilePathView	path,
		OpenMode	openMode = `OpenMode::Trunc`,
		TextEncoding	encoding = `TextEncoding::UTF8_WITH_BOM`
	)

テキストファイルをオープンします。

Parameters

path	ファイルパス
openMode	ファイルのオープンモード
encoding	テキストのエンコーディング形式

Returns: ファイルのオープンに成功した場合 true, それ以外の場合は false

◆ open() [2/2]

bool s3d::TextWriter::open	(	FilePathView	path,
		TextEncoding	encoding
	)

テキストファイルをオープンします。

Parameters

path	ファイルパス
encoding	テキストのエンコーディング形式

Returns: ファイルのオープンに成功した場合 true, それ以外の場合は false

◆ operator bool()

s3d::TextWriter::operator bool ( ) const

explicitnoexcept

テキストファイルがオープンされているかを返します。

Remarks: isOpen() と同じです。

Returns: ファイルがオープンされている場合 true, それ以外の場合は false

◆ operator<<()

SIV3D_CONCEPT_FORMATTABLE detail::TextWriterBuffer s3d::TextWriter::operator<< ( const Formattable & value )

データを文字列に変換してファイルに書き込み、一連の << が終わったあとに改行します。

Parameters

value 書き込むデータ

Returns: 続いて << できるオブジェクト

◆ path()

const FilePath& s3d::TextWriter::path ( ) const

noexcept

オープンしているファイルのフルパスを返します。

Returns: ファイルがオープンしている場合、ファイルのフルパス。それ以外の場合は空の文字列。

◆ write() [1/6]

void s3d::TextWriter::write ( char ch )

delete

ファイルに文字を書き込みます。

Parameters

ch 書き込む文字

◆ write() [2/6]

void s3d::TextWriter::write ( char32 ch )

ファイルに文字を書き込みます。

Parameters

ch 書き込む文字

◆ write() [3/6]

SIV3D_CONCEPT_FORMATTABLE_ARGS void s3d::TextWriter::write ( const Args &... args )

データを文字列に変換してファイルに書き込みます。

Parameters

args 書き込むデータ

◆ write() [4/6]

void s3d::TextWriter::write ( const char32 * s )

ファイルに文字列を書き込みます。

Parameters

s 書き込む文字列

◆ write() [5/6]

void s3d::TextWriter::write ( const String & s )

ファイルに文字列を書き込みます。

Parameters

s 書き込む文字列

◆ write() [6/6]

void s3d::TextWriter::write ( StringView s )

ファイルに文字列を書き込みます。

Parameters

s 書き込む文字列

◆ writeln() [1/6]

void s3d::TextWriter::writeln ( char ch )

delete

◆ writeln() [2/6]

void s3d::TextWriter::writeln ( char32 ch )

ファイルに文字を書き込み、改行します。

Parameters

ch 書き込む文字

◆ writeln() [3/6]

SIV3D_CONCEPT_FORMATTABLE_ARGS void s3d::TextWriter::writeln ( const Args &... args )

データを文字列に変換してファイルに書き込み、改行します。

Parameters

args 書き込むデータ

◆ writeln() [4/6]

void s3d::TextWriter::writeln ( const char32 * s )

ファイルに文字列を書き込み、改行します。

Parameters

s 書き込む文字列

◆ writeln() [5/6]

void s3d::TextWriter::writeln ( const String & s )

ファイルに文字列を書き込み、改行します。

Parameters

s 書き込む文字列

◆ writeln() [6/6]

void s3d::TextWriter::writeln ( StringView s )

ファイルに文字列を書き込み、改行します。

Parameters

s 書き込む文字列

◆ writelnUTF8()

void s3d::TextWriter::writelnUTF8 ( std::string_view s )

ファイルに UTF-8 文字列を書き込み、改行します。

Remarks: ファイルのエンコーディング形式が UTF8_NO_BOM UTF8_WITH_BOM である場合、エンコーディング変換をスキップするためパフォーマンスが向上します。

Parameters

s UTF-8 文字列

◆ writeUTF8()

void s3d::TextWriter::writeUTF8 ( std::string_view s )

ファイルに UTF-8 文字列を書き込みます。

Remarks: ファイルのエンコーディング形式が UTF8_NO_BOM UTF8_WITH_BOM である場合、エンコーディング変換をスキップするためパフォーマンスが向上します。

Parameters

s UTF-8 文字列

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

OpenSiv3D/Siv3D/include/Siv3D/TextWriter.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ TextWriter() [1/3]

◆ TextWriter() [2/3]

◆ TextWriter() [3/3]

Member Function Documentation

◆ clear()

◆ close()

◆ encoding()

◆ isOpen()

◆ open() [1/2]

◆ open() [2/2]

◆ operator bool()

◆ operator<<()

◆ path()

◆ write() [1/6]

◆ write() [2/6]

◆ write() [3/6]

◆ write() [4/6]

◆ write() [5/6]

◆ write() [6/6]

◆ writeln() [1/6]

◆ writeln() [2/6]

◆ writeln() [3/6]

◆ writeln() [4/6]

◆ writeln() [5/6]

◆ writeln() [6/6]

◆ writelnUTF8()

◆ writeUTF8()