提供資料寫入功能的簡易實現類更多...

#include <SimpleWriter.h>

類別ufm::io::SimpleWriter的繼承圖:

公開方法(Public Methods)
	SimpleWriter (const ufm::lang::Data &source)
	使用指定的資料來源建立寫入器

	SimpleWriter (void *pointer, int length)
	使用指定的資料來源建立寫入器

virtual	~SimpleWriter (void) override
	銷毀物件，釋放相關資源

virtual int	remaining (void) const override
	取得緩衝區剩餘空閒字節數。

virtual int	putByte (const char data) override
	輸入單一字節至緩衝區

virtual int	put (ufm::lang::Readable &readable) override
	從 Readable 物件附加資料至緩衝區

virtual int	put (const void *pointer, int length) override
	從記憶體指標附加資料至緩衝區

virtual void	refresh (void) override
	刷新當前狀態或資料

公開方法(Public Methods) 繼承自 ufm::lang::Data
	Data (void)
	建立新的 Data 物件

	Data (const char *pointer)
	根據字元指標建立 Data 物件

	Data (const void *pointer, int length)
	使用常數 void 指標及長度建立 Data 物件

	Data (void *pointer, int length)
	使用可修改 void 指標及長度建立 Data 物件

	Data (const Data &other)
	複製建構子，根據現有 Data 物件建立新物件

Data &	operator= (const Data &other)=default
	賦值運算子，將另一個 Data 物件的內容複製到當前物件

virtual int	copy (const void *source, int shift, int start, int length) override
	將來源資料複製到 Data 物件中

bool	isReadOnly (void) const
	檢查資料是否唯讀

int	length (void) const
	取得資料有效長度

uint32	lengthUnsigned (void) const
	取得資料無符號長度

int	wipe (void)
	以預設值 0x00 擦除所有資料

int	wipe (uint8 value)
	以指定值擦除所有資料

int	wipe (uint8 value, int length)
	從起始處以指定長度使用指定值擦除資料

int	popArray (int start, int length)
	從指定起始位置取出陣列資料（不儲存結果）

int	popArray (void *source, int start, int length)
	從指定起始位置取出陣列資料並儲存至指定來源

int	insertArray (const void *source, int start, int length)
	將來源陣列資料插入到 Data 物件中

bool	inRange (void *address) const
	檢查指定位址是否落在資料範圍內

int	wipe (uint8 value, int start, int length)
	從指定起始位置以指定長度擦除資料

ufm::lang::Data	subData (int beginIndex, int length) const
	取得子資料區段

int	insertArray (const void *source, int shift, int start, int length)
	將來源陣列資料依指定位移複製至 Data 物件中

int	popArray (void *source, int shift, int start, int length)
	從 Data 物件中依指定位移取出陣列資料

virtual int	hashdata (void) const
	計算資料雜湊值

int	copy (const void *source, int length)
	複製來源資料至內部資料區塊，使用預設偏移參數

int	copy (const void *source, int offset, int length)
	複製來源資料至內部資料區塊，可指定目標位址偏移

公開方法(Public Methods) 繼承自 ufm::lang::Pointer
	Pointer (void)
	儲存指標的內部成員變數

	Pointer (const void *pointer)
	建立一個 Pointer 物件，並以 const void* 初始化內部指標

	Pointer (void *pointer)
	建立一個 Pointer 物件，並以 void* 初始化內部指標

	Pointer (uint32 pointer)
	建立一個 Pointer 物件，並以 32 位元整數表示的位址初始化

	Pointer (const Pointer &other)
	複製建構子，從另一個 Pointer 物件複製內部位址

	operator void * (void)
	隱式轉換為 void*，可直接取得內部指標

	operator const char * (void)
	隱式轉換為 const char*，適用於字串存取

bool	operator== (const void *pointer)
	比較內部指標與外部指標是否相同

bool	operator== (const Pointer &pointer)
	比較兩個 Pointer 物件的內部指標是否相同

template<typename E >
	operator E* (void)
	模板運算子，將內部指標轉換為指定型態的指標（非 const 版本）

template<typename E >
	operator E* (void) const
	模板運算子，將內部指標轉換為指定型態的指標（const 版本）

Pointer &	operator= (const Pointer &other)=default
	賦值運算子，將另一個 Pointer 物件的內部指標複製到當前物件

int	copyTo (void *destination, int length) const
	複製內部資料至目標記憶體區塊

int	copyTo (void *destination, int start, int length) const
	複製內部資料至目標記憶體區塊，可指定來源起始位置

bool	compairStrings (const char *str) const
	比較內部資料與傳入字串是否相同（從起始位置開始比較）

bool	compairStrings (const char *str, int start) const
	比較內部資料與傳入字串是否相同，可指定來源資料起始位置

bool	compair (const void *source, int length) const
	比較內部資料與來源資料是否相等（從起始位置開始比較）

bool	compair (const void *source, int start, int length) const
	比較內部資料與來源資料是否相等，可指定來源資料的起始偏移

int	indexOf (char ch, int start, int limit) const
	在內部資料中查找指定字元 ch，回傳該字元的偏移位置

int	indexOfStrings (const char *str, int limit) const
	在內部資料中查找指定字串，回傳該字串的偏移位置（使用預設起始位置）

int	indexOfStrings (const char *str, int start, int limit) const
	在內部資料中查找指定字串，回傳該字串的偏移位置

int	copy (const void *source, int length)
	複製來源資料至內部資料區塊，使用預設偏移參數

int	copy (const void *source, int offset, int length)
	複製來源資料至內部資料區塊，可指定目標位址偏移

char	getByte (int shift) const
	取得指定偏移處的 byte 值

int	getInteger (int shift) const
	取得指定偏移處的整數值

short	getShort (int shift) const
	取得指定偏移處的 short 值

Pointer	getPointer (int offset) const
	以指定偏移建立新的 Pointer 物件

uint32	getAddress (void) const
	取得內部記憶體位址的整數表示

bool	isAlignment32Bit (void)
	檢查內部位址是否 32 位元對齊

bool	isAlignment64Bit (void)
	檢查內部位址是否 64 位元對齊

bool	isNull (void) const
	檢查內部指標是否為空

template<typename E = void*>
E *	pointer (void) const
	模板方法，取得內部指標並轉換為指定型態（不指定偏移）

template<typename E = void*>
E *	pointer (int offset) const
	模板方法，取得內部指標並轉換為指定型態（指定偏移）

template<typename E = void*>
E *	pointer (uint32 offset) const
	模板方法，取得內部指標並轉換為指定型態（指定偏移，使用 uint32 參數）

virtual int	copyTo (void *destination, int offset, int destinationOffset, int length) const
	將內部資料複製到目標記憶體區塊，可指定來源與目標的起始偏移

virtual bool	compair (const void *source, int offset, int sourceOffset, int length) const
	比較內部資料與來源資料是否相等，可指定各自的起始偏移與比較長度

virtual int	indexOfData (const void *destination, int destinationLen, int start=0, int limit=0) const
	尋找指定 pattern 是否存在於內部資料中，並返回第一個符合條件的偏移量

virtual void	move (int head, int offset, int length)
	將來源位置的資料以中間緩衝區方式移動至新的位置

公開方法(Public Methods) 繼承自 ufm::lang::Object
void *	operator new (size_t n)
	使用運算子 new 分配記憶體

void *	operator new (size_t n, void *p)
	在指定記憶體上調用運算子 new

virtual ufm::lang::Object &	getObject (void) override
	取得對應的 Object 物件

void	delay (int milliseconds) const
	延遲指定的毫秒數進行執行緒等待

bool	equals (Object *object) const
	判斷與另一物件是否為相同參照（指標型態比較）

bool	equals (Object &object) const
	判斷與另一物件是否為相同參照（參照型態比較）

void	wait (void) const
	使當前線程等待直到被通知

bool	wait (int timeout) const
	等待通知或超時

bool	yield (void) const
	讓執行緒讓渡控制權給同優先權的下一個執行緒

int	lock (void) const
	核心鎖定，鎖定期間禁止線程切換

int	unlock (void) const
	核心解鎖

ufm::sys::Thread *	currentThread (void) const
	取得當前執行緒指標

virtual int	hashcode (void) const
	返回對象的哈希碼值。支持這種方法是為了散列表，如HashMap提供的那樣。

公開方法(Public Methods) 繼承自 ufm::lang::Interface
virtual	~Interface (void)=default
	虛擬析構函式

公開方法(Public Methods) 繼承自 ufm::lang::Appendable
int	put (ufm::lang::Readable &&readable)
	從右值 Readable 附加資料

bool	isFull (void) const
	檢查緩衝區是否已滿

額外的繼承成員
靜態公開方法(Static Public Methods) 繼承自 ufm::lang::Data
static void	wipe (void *pointer, uint8 value, int length)
	使用指定值擦除記憶體區塊

static void	wipe (void *pointer, int length)
	根據指定長度擦除記憶體區塊

詳細描述

提供資料寫入功能的簡易實現類

此類繼承自 ufm::lang::Data，並實作 ufm::lang::Appendable 與 ufm::lang::Flushable 介面，提供將資料寫入目標記憶體區域的功能。SimpleWriter 維護一個位置指針，用於追蹤當前寫入的位置。適用於需要順序寫入資料到固定記憶體區域的場景。

自: 1.0.0

建構子與解構子說明文件

◆ SimpleWriter() [1/2]

ufm::io::SimpleWriter::SimpleWriter ( const ufm::lang::Data & source )

使用指定的資料來源建立寫入器

參數

source 資料來源，提供寫入的目標記憶體區域

◆ SimpleWriter() [2/2]

ufm::io::SimpleWriter::SimpleWriter	(	void *	pointer,
		int	length )

inline

使用指定的資料來源建立寫入器

參數

source 資料來源，提供寫入的目標記憶體區域

函式成員說明文件

◆ put() [1/2]

virtual int ufm::io::SimpleWriter::put	(	const void *	pointer,
		int	length )

overridevirtual

從記憶體指標附加資料至緩衝區

根據指定長度，將 pointer 指向的資料寫入緩衝區

參數

pointer	資料來源位址
length	要寫入的字節數

傳回值: int 實際寫入的字節數

實作 ufm::lang::Appendable.

◆ put() [2/2]

virtual int ufm::io::SimpleWriter::put ( ufm::lang::Readable & readable )

overridevirtual

從 Readable 物件附加資料至緩衝區

迴圈從 readable 讀取並寫入緩衝區，直到耗盡或空間不足

參數

readable 可讀資料來源

傳回值: int 實際寫入的字節數

實作 ufm::lang::Appendable.

◆ putByte()

virtual int ufm::io::SimpleWriter::putByte ( const char data )

overridevirtual

輸入單一字節至緩衝區

參數

data 要寫入的字節

傳回值: int 寫入後緩衝區剩餘空間（字節數）

實作 ufm::lang::Appendable.

◆ refresh()

virtual void ufm::io::SimpleWriter::refresh ( void )

overridevirtual

刷新當前狀態或資料

此方法用於重新載入或更新物件的狀態，通常在資料來源變更後調用。實作此介面的類別應確保在呼叫此方法後，物件的狀態是最新的。

自: 1.0.0

實作 ufm::lang::Refreshable.

◆ remaining()

virtual int ufm::io::SimpleWriter::remaining ( void ) const

overridevirtual

取得緩衝區剩餘空閒字節數。

傳回值: int 剩餘的空閒字節數。

實作 ufm::lang::Appendable.

此類別(class) 文件是由下列檔案中產生:

SimpleWriter.h

公開方法(Public Methods)

額外的繼承成員

詳細描述

建構子與解構子說明文件

◆ SimpleWriter() [1/2]

◆ SimpleWriter() [2/2]

函式成員說明文件

◆ put() [1/2]

◆ put() [2/2]

◆ putByte()

◆ refresh()

◆ remaining()