Class ObservableCacheAlias

Namespace

DynamicData.Alias

Assembly

DynamicData.dll

Observable cache alias names.

public static class ObservableCacheAlias

Inheritance

object

ObservableCacheAlias

Methods

SelectMany<TDestination, TDestinationKey, TSource, TSourceKey>(IObservable<IChangeSet<TSource, TSourceKey>>, Func<TSource, IEnumerable<TDestination>>, Func<TDestination, TDestinationKey>)

Equivalent to a select many transform. To work, the key must individually identify each child.

public static IObservable<IChangeSet<TDestination, TDestinationKey>> SelectMany<TDestination, TDestinationKey, TSource, TSourceKey>(this IObservable<IChangeSet<TSource, TSourceKey>> source, Func<TSource, IEnumerable<TDestination>> manySelector, Func<TDestination, TDestinationKey> keySelector) where TDestination : notnull where TDestinationKey : notnull where TSource : notnull where TSourceKey : notnull

Parameters

source IObservable<IChangeSet<TSource, TSourceKey>>

The source.

manySelector Func<TSource, IEnumerable<TDestination>>

The selector for selecting the enumerable.

keySelector Func<TDestination, TDestinationKey>

The key selector which must be unique across all.

Returns

IObservable<IChangeSet<TDestination, TDestinationKey>>

An observable which emits the change set.

Type Parameters

TDestination

The type of the destination.

TDestinationKey

The type of the destination key.

TSource

The type of the source.

TSourceKey

The type of the source key.

SelectSafe<TDestination, TSource, TKey>(IObservable<IChangeSet<TSource, TKey>>, Func<TSource, TDestination>, Action<Error<TSource, TKey>>, IObservable<Func<TSource, bool>>?)

Projects each update item to a new form using the specified transform function, providing an error handling action to safely handle transform errors without killing the stream.

public static IObservable<IChangeSet<TDestination, TKey>> SelectSafe<TDestination, TSource, TKey>(this IObservable<IChangeSet<TSource, TKey>> source, Func<TSource, TDestination> transformFactory, Action<Error<TSource, TKey>> errorHandler, IObservable<Func<TSource, bool>>? forceTransform = null) where TDestination : notnull where TSource : notnull where TKey : notnull

Parameters

source IObservable<IChangeSet<TSource, TKey>>

The source.

transformFactory Func<TSource, TDestination>

The transform factory.

errorHandler Action<Error<TSource, TKey>>

Provides the option to safely handle errors without killing the stream. If not specified the stream will terminate as per rx convention.

forceTransform IObservable<Func<TSource, bool>>

Invoke to force a new transform for items matching the selected objects.

Returns

IObservable<IChangeSet<TDestination, TKey>>

A transformed update collection.

Type Parameters

TDestination

The type of the destination.

TSource

The type of the source.

TKey

The type of the key.

Exceptions

ArgumentNullException

source or transformFactory.

SelectSafe<TDestination, TSource, TKey>(IObservable<IChangeSet<TSource, TKey>>, Func<TSource, TDestination>, Action<Error<TSource, TKey>>, IObservable<Unit>)

Projects each update item to a new form using the specified transform function, providing an error handling action to safely handle transform errors without killing the stream.

public static IObservable<IChangeSet<TDestination, TKey>> SelectSafe<TDestination, TSource, TKey>(this IObservable<IChangeSet<TSource, TKey>> source, Func<TSource, TDestination> transformFactory, Action<Error<TSource, TKey>> errorHandler, IObservable<Unit> forceTransform) where TDestination : notnull where TSource : notnull where TKey : notnull

Parameters

source IObservable<IChangeSet<TSource, TKey>>

The source.

transformFactory Func<TSource, TDestination>

The transform factory.

errorHandler Action<Error<TSource, TKey>>

Provides the option to safely handle errors without killing the stream. If not specified the stream will terminate as per rx convention.

forceTransform IObservable<Unit>

Invoke to force a new transform for items matching the selected objects.

Returns

IObservable<IChangeSet<TDestination, TKey>>

A transformed update collection.

Type Parameters

TDestination

The type of the destination.

TSource

The type of the source.

TKey

The type of the key.

Exceptions

ArgumentNullException

source or transformFactory.

SelectSafe<TDestination, TSource, TKey>(IObservable<IChangeSet<TSource, TKey>>, Func<TSource, TKey, TDestination>, Action<Error<TSource, TKey>>, IObservable<Func<TSource, TKey, bool>>?)

Projects each update item to a new form using the specified transform function, providing an error handling action to safely handle transform errors without killing the stream.

public static IObservable<IChangeSet<TDestination, TKey>> SelectSafe<TDestination, TSource, TKey>(this IObservable<IChangeSet<TSource, TKey>> source, Func<TSource, TKey, TDestination> transformFactory, Action<Error<TSource, TKey>> errorHandler, IObservable<Func<TSource, TKey, bool>>? forceTransform = null) where TDestination : notnull where TSource : notnull where TKey : notnull

Parameters

source IObservable<IChangeSet<TSource, TKey>>

The source.

transformFactory Func<TSource, TKey, TDestination>

The transform factory.

errorHandler Action<Error<TSource, TKey>>

Provides the option to safely handle errors without killing the stream. If not specified the stream will terminate as per rx convention.

forceTransform IObservable<Func<TSource, TKey, bool>>

Invoke to force a new transform for items matching the selected objects.

Returns

IObservable<IChangeSet<TDestination, TKey>>

A transformed update collection.

Type Parameters

TDestination

The type of the destination.

TSource

The type of the source.

TKey

The type of the key.

Exceptions

ArgumentNullException

source or transformFactory.

SelectSafe<TDestination, TSource, TKey>(IObservable<IChangeSet<TSource, TKey>>, Func<TSource, TKey, TDestination>, Action<Error<TSource, TKey>>, IObservable<Unit>)

Projects each update item to a new form using the specified transform function, providing an error handling action to safely handle transform errors without killing the stream.

public static IObservable<IChangeSet<TDestination, TKey>> SelectSafe<TDestination, TSource, TKey>(this IObservable<IChangeSet<TSource, TKey>> source, Func<TSource, TKey, TDestination> transformFactory, Action<Error<TSource, TKey>> errorHandler, IObservable<Unit> forceTransform) where TDestination : notnull where TSource : notnull where TKey : notnull

Parameters

source IObservable<IChangeSet<TSource, TKey>>

The source.

transformFactory Func<TSource, TKey, TDestination>

The transform factory.

errorHandler Action<Error<TSource, TKey>>

Provides the option to safely handle errors without killing the stream. If not specified the stream will terminate as per rx convention.

forceTransform IObservable<Unit>

Invoke to force a new transform for all items.

Returns

IObservable<IChangeSet<TDestination, TKey>>

A transformed update collection.

Type Parameters

TDestination

The type of the destination.

TSource

The type of the source.

TKey

The type of the key.

Exceptions

ArgumentNullException

source or transformFactory.

SelectTree<TObject, TKey>(IObservable<IChangeSet<TObject, TKey>>, Func<TObject, TKey>)

Transforms the object to a fully recursive tree, create a hierarchy based on the pivot function.

public static IObservable<IChangeSet<Node<TObject, TKey>, TKey>> SelectTree<TObject, TKey>(this IObservable<IChangeSet<TObject, TKey>> source, Func<TObject, TKey> pivotOn) where TObject : class where TKey : notnull

Parameters

source IObservable<IChangeSet<TObject, TKey>>

The source.

pivotOn Func<TObject, TKey>

The pivot on.

Returns

IObservable<IChangeSet<Node<TObject, TKey>, TKey>>

An observable which emits the change set.

Type Parameters

TObject

The type of the object.

TKey

The type of the key.

Select<TDestination, TSource, TKey>(IObservable<IChangeSet<TSource, TKey>>, Func<TSource, TDestination>, IObservable<Func<TSource, bool>>?)

Projects each update item to a new form using the specified transform function.

public static IObservable<IChangeSet<TDestination, TKey>> Select<TDestination, TSource, TKey>(this IObservable<IChangeSet<TSource, TKey>> source, Func<TSource, TDestination> transformFactory, IObservable<Func<TSource, bool>>? forceTransform = null) where TDestination : notnull where TSource : notnull where TKey : notnull

Parameters

source IObservable<IChangeSet<TSource, TKey>>

The source.

transformFactory Func<TSource, TDestination>

The transform factory.

forceTransform IObservable<Func<TSource, bool>>

Invoke to force a new transform for items matching the selected objects.

Returns

IObservable<IChangeSet<TDestination, TKey>>

A transformed update collection.

Type Parameters

TDestination

The type of the destination.

TSource

The type of the source.

TKey

The type of the key.

Exceptions

ArgumentNullException

source or transformFactory.

Select<TDestination, TSource, TKey>(IObservable<IChangeSet<TSource, TKey>>, Func<TSource, TDestination>, IObservable<Unit>)

Projects each update item to a new form using the specified transform function.

public static IObservable<IChangeSet<TDestination, TKey>> Select<TDestination, TSource, TKey>(this IObservable<IChangeSet<TSource, TKey>> source, Func<TSource, TDestination> transformFactory, IObservable<Unit> forceTransform) where TDestination : notnull where TSource : notnull where TKey : notnull

Parameters

source IObservable<IChangeSet<TSource, TKey>>

The source.

transformFactory Func<TSource, TDestination>

The transform factory.

forceTransform IObservable<Unit>

Invoke to force a new transform for all items.

Returns

IObservable<IChangeSet<TDestination, TKey>>

A transformed update collection.

Type Parameters

TDestination

The type of the destination.

TSource

The type of the source.

TKey

The type of the key.

Exceptions

ArgumentNullException

source or transformFactory.

Select<TDestination, TSource, TKey>(IObservable<IChangeSet<TSource, TKey>>, Func<TSource, TKey, TDestination>, IObservable<Func<TSource, TKey, bool>>?)

Projects each update item to a new form using the specified transform function.

public static IObservable<IChangeSet<TDestination, TKey>> Select<TDestination, TSource, TKey>(this IObservable<IChangeSet<TSource, TKey>> source, Func<TSource, TKey, TDestination> transformFactory, IObservable<Func<TSource, TKey, bool>>? forceTransform = null) where TDestination : notnull where TSource : notnull where TKey : notnull

Parameters

source IObservable<IChangeSet<TSource, TKey>>

The source.

transformFactory Func<TSource, TKey, TDestination>

The transform factory.

forceTransform IObservable<Func<TSource, TKey, bool>>

Invoke to force a new transform for items matching the selected objects.

Returns

IObservable<IChangeSet<TDestination, TKey>>

A transformed update collection.

Type Parameters

TDestination

The type of the destination.

TSource

The type of the source.

TKey

The type of the key.

Exceptions

ArgumentNullException

source or transformFactory.

Select<TDestination, TSource, TKey>(IObservable<IChangeSet<TSource, TKey>>, Func<TSource, TKey, TDestination>, IObservable<Unit>)

Projects each update item to a new form using the specified transform function.

public static IObservable<IChangeSet<TDestination, TKey>> Select<TDestination, TSource, TKey>(this IObservable<IChangeSet<TSource, TKey>> source, Func<TSource, TKey, TDestination> transformFactory, IObservable<Unit> forceTransform) where TDestination : notnull where TSource : notnull where TKey : notnull

Parameters

source IObservable<IChangeSet<TSource, TKey>>

The source.

transformFactory Func<TSource, TKey, TDestination>

The transform factory.

forceTransform IObservable<Unit>

Invoke to force a new transform for all items.

Returns

IObservable<IChangeSet<TDestination, TKey>>

A transformed update collection.

Type Parameters

TDestination

The type of the destination.

TSource

The type of the source.

TKey

The type of the key.

Exceptions

ArgumentNullException

source or transformFactory.

Where<TObject, TKey>(IObservable<IChangeSet<TObject, TKey>>, Func<TObject, bool>)

Filters the specified source.

public static IObservable<IChangeSet<TObject, TKey>> Where<TObject, TKey>(this IObservable<IChangeSet<TObject, TKey>> source, Func<TObject, bool> filter) where TObject : notnull where TKey : notnull

Parameters

source IObservable<IChangeSet<TObject, TKey>>

The source.

filter Func<TObject, bool>

The filter.

Returns

IObservable<IChangeSet<TObject, TKey>>

An observable which emits the change set.

Type Parameters

TObject

The type of the object.

TKey

The type of the key.

Where<TObject, TKey>(IObservable<IChangeSet<TObject, TKey>>, IObservable<Func<TObject, bool>>)

Creates a filtered stream which can be dynamically filtered.

public static IObservable<IChangeSet<TObject, TKey>> Where<TObject, TKey>(this IObservable<IChangeSet<TObject, TKey>> source, IObservable<Func<TObject, bool>> predicateChanged) where TObject : notnull where TKey : notnull

Parameters

source IObservable<IChangeSet<TObject, TKey>>

The source.

predicateChanged IObservable<Func<TObject, bool>>

Observable to change the underlying predicate.

Returns

IObservable<IChangeSet<TObject, TKey>>

An observable which emits the change set.

Type Parameters

TObject

The type of the object.

TKey

The type of the key.

Where<TObject, TKey>(IObservable<IChangeSet<TObject, TKey>>, IObservable<Func<TObject, bool>>, IObservable<Unit>)

Creates a filtered stream which can be dynamically filtered.

public static IObservable<IChangeSet<TObject, TKey>> Where<TObject, TKey>(this IObservable<IChangeSet<TObject, TKey>> source, IObservable<Func<TObject, bool>> predicateChanged, IObservable<Unit> reapplyFilter) where TObject : notnull where TKey : notnull

Parameters

source IObservable<IChangeSet<TObject, TKey>>

The source.

predicateChanged IObservable<Func<TObject, bool>>

Observable to change the underlying predicate.

reapplyFilter IObservable<Unit>

Observable to re-evaluate whether the filter still matches items. Use when filtering on mutable values.

Returns

IObservable<IChangeSet<TObject, TKey>>

An observable which emits the change set.

Type Parameters

TObject

The type of the object.

TKey

The type of the key.

Where<TObject, TKey>(IObservable<IChangeSet<TObject, TKey>>, IObservable<Unit>)

Creates a filtered stream which can be dynamically filtered.

public static IObservable<IChangeSet<TObject, TKey>> Where<TObject, TKey>(this IObservable<IChangeSet<TObject, TKey>> source, IObservable<Unit> reapplyFilter) where TObject : notnull where TKey : notnull

Parameters

source IObservable<IChangeSet<TObject, TKey>>

The source.

reapplyFilter IObservable<Unit>

Observable to re-evaluate whether the filter still matches items. Use when filtering on mutable values.

Returns

IObservable<IChangeSet<TObject, TKey>>

An observable which emits the change set.

Type Parameters

TObject

The type of the object.

TKey

The type of the key.