UniRx.CompositeDisposable Class Reference

Inheritance diagram for UniRx.CompositeDisposable:

Public Member Functions
	CompositeDisposable ()
	Initializes a new instance of the T:System.Reactive.Disposables.CompositeDisposable class with no disposables contained by it initially.
	CompositeDisposable (int capacity)
	Initializes a new instance of the T:System.Reactive.Disposables.CompositeDisposable class with the specified number of disposables. More...
	CompositeDisposable (params IDisposable[] disposables)
	Initializes a new instance of the T:System.Reactive.Disposables.CompositeDisposable class from a group of disposables. More...
	CompositeDisposable (IEnumerable< IDisposable > disposables)
	Initializes a new instance of the T:System.Reactive.Disposables.CompositeDisposable class from a group of disposables. More...
void	Add (IDisposable item)
	Adds a disposable to the CompositeDisposable or disposes the disposable if the CompositeDisposable is disposed. More...
bool	Remove (IDisposable item)
	Removes and disposes the first occurrence of a disposable from the CompositeDisposable. More...
void	Dispose ()
	Disposes all disposables in the group and removes them from the group.
void	Clear ()
	Removes and disposes all disposables from the CompositeDisposable, but does not dispose the CompositeDisposable.
bool	Contains (IDisposable item)
	Determines whether the CompositeDisposable contains a specific disposable. More...
void	CopyTo (IDisposable[] array, int arrayIndex)
	Copies the disposables contained in the CompositeDisposable to an array, starting at a particular array index. More...
IEnumerator< IDisposable >	GetEnumerator ()
	Returns an enumerator that iterates through the CompositeDisposable. More...

Properties
int	Count [get]
	Gets the number of disposables contained in the CompositeDisposable.
bool	IsReadOnly [get]
	Always returns false.
bool	IsDisposed [get]
	Gets a value that indicates whether the object is disposed. More...
Properties inherited from UniRx.ICancelable
bool	IsDisposed [get]

Constructor & Destructor Documentation

CompositeDisposable() [1/3]

UniRx.CompositeDisposable.CompositeDisposable

(

int

capacity

)

Initializes a new instance of the T:System.Reactive.Disposables.CompositeDisposable class with the specified number of disposables.

Parameters

capacity

The number of disposables that the new CompositeDisposable can initially store.

Exceptions

ArgumentOutOfRangeException

capacity is less than zero.

CompositeDisposable() [2/3]

UniRx.CompositeDisposable.CompositeDisposable

(

params IDisposable[]

disposables

)

Initializes a new instance of the T:System.Reactive.Disposables.CompositeDisposable class from a group of disposables.

Parameters

disposables

Disposables that will be disposed together.

Exceptions

ArgumentNullException

disposables is null.

CompositeDisposable() [3/3]

UniRx.CompositeDisposable.CompositeDisposable

(

IEnumerable< IDisposable >

disposables

)

Initializes a new instance of the T:System.Reactive.Disposables.CompositeDisposable class from a group of disposables.

Parameters

disposables

Disposables that will be disposed together.

Exceptions

ArgumentNullException

disposables is null.

Member Function Documentation

Add()

void UniRx.CompositeDisposable.Add

(

IDisposable

item

)

Adds a disposable to the CompositeDisposable or disposes the disposable if the CompositeDisposable is disposed.

Parameters

item	Disposable to add.

Exceptions

ArgumentNullException

item is null.

Contains()

bool UniRx.CompositeDisposable.Contains

(

IDisposable

item

)

Determines whether the CompositeDisposable contains a specific disposable.

Parameters

item	Disposable to search for.

Returns

true if the disposable was found; otherwise, false.

Exceptions

ArgumentNullException

item is null.

CopyTo()

void UniRx.CompositeDisposable.CopyTo	(	IDisposable[]	array,
		int	arrayIndex
	)

Copies the disposables contained in the CompositeDisposable to an array, starting at a particular array index.

Parameters

array	Array to copy the contained disposables to.
arrayIndex	Target index at which to copy the first disposable of the group.

Exceptions

ArgumentNullException	array is null.
ArgumentOutOfRangeException	arrayIndex is less than zero. -or - arrayIndex is larger than or equal to the array length.

GetEnumerator()

IEnumerator< IDisposable > UniRx.CompositeDisposable.GetEnumerator

(

)

Returns an enumerator that iterates through the CompositeDisposable.

Returns

An enumerator to iterate over the disposables.

Remove()

bool UniRx.CompositeDisposable.Remove

(

IDisposable

item

)

Removes and disposes the first occurrence of a disposable from the CompositeDisposable.

Parameters

item	Disposable to remove.

Returns

true if found; false otherwise.

Exceptions

ArgumentNullException

item is null.

Property Documentation

IsDisposed

bool UniRx.CompositeDisposable.IsDisposed

get

Gets a value that indicates whether the object is disposed.

Implements UniRx.ICancelable.

---

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

• CompositeDisposable.cs