Loyc.SyncLib.Impl.IListBuilder< out TList, T > Interface Template Reference

An interface implemented by adapters that help read and write lists of various types, e.g. ListBuilder{T}. The adapter can be used to read a collection once or write it once, but not both. More...

---

Source file:

• /Core/Loyc.Essentials/SyncLib/Impl/IListBuilder.cs

Inheritance diagram for Loyc.SyncLib.Impl.IListBuilder< out TList, T >:

Remarks

An interface implemented by adapters that help read and write lists of various types, e.g. ListBuilder{T}. The adapter can be used to read a collection once or write it once, but not both.

Properties
TList	List [get]
	Called once when done loading to retrieve the list. More...
TList	Empty [get]
	Returns an empty list, bypassing the normal building process More...

Public Member Functions
object	Alloc (int minLength)
	A method that is always called once when loading a list. More...
TList	CastList (object value)
	When the list being loaded was already read from the data stream earlier, this property is called to convert that existing object to the target list type, skipping the usual calls to Alloc(), Add(T) and List. More...

Member Function Documentation

object Loyc.SyncLib.Impl.IListBuilder< out TList, T >.Alloc

(

int

minLength

)

A method that is always called once when loading a list.

Parameters

minLength

Minimum list size (ISyncManager.MinimumListLength)

Returns

Returns the list object so that it can be assigned as the ISyncManager.CurrentObject in case the list contains a cyclic reference to itself. If a cyclic reference is not possible, this method can return null.

Implemented in Loyc.SyncLib.Impl.SyncLibStringBuilder, Loyc.SyncLib.Impl.CollectionBuilder< TList, T >, Loyc.SyncLib.Impl.MemoryBuilder< T >, Loyc.SyncLib.Impl.ArrayBuilder< T >, and Loyc.SyncLib.Impl.ListBuilder< T >.

TList Loyc.SyncLib.Impl.IListBuilder< out TList, T >.CastList

(

object

value

)

When the list being loaded was already read from the data stream earlier, this property is called to convert that existing object to the target list type, skipping the usual calls to Alloc(), Add(T) and List.

Implemented in Loyc.SyncLib.Impl.SyncLibStringBuilder, Loyc.SyncLib.Impl.CollectionBuilder< TList, T >, Loyc.SyncLib.Impl.MemoryBuilder< T >, Loyc.SyncLib.Impl.MemoryBuilder< T >, Loyc.SyncLib.Impl.ArrayBuilder< T >, and Loyc.SyncLib.Impl.ListBuilder< T >.

Property Documentation

TList Loyc.SyncLib.Impl.IListBuilder< out TList, T >.Empty

get

Returns an empty list, bypassing the normal building process

TList Loyc.SyncLib.Impl.IListBuilder< out TList, T >.List

get

Called once when done loading to retrieve the list.