Class CachedComposition

Namespace

Microsoft.VisualStudio.Composition

Assembly

Microsoft.VisualStudio.Composition.dll

public class CachedComposition : ICompositionCacheManager, IRuntimeCompositionCacheManager

Inheritance

object

CachedComposition

Implements

ICompositionCacheManager

IRuntimeCompositionCacheManager

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

LoadExportProviderFactoryAsync(Stream, Resolver, ExportProviderFactoryOptions, JoinableTaskFactory?, CancellationToken)

Creates an IExportProviderFactory for this cached composition.

public Task<IExportProviderFactory> LoadExportProviderFactoryAsync(Stream cacheStream, Resolver resolver, ExportProviderFactoryOptions options, JoinableTaskFactory? joinableTaskFactory, CancellationToken cancellationToken)

Parameters

cacheStream Stream

The stream to read the cached composition from.

resolver Resolver

The resolver to use when loading the composition.

options ExportProviderFactoryOptions

Options that control export provider runtime behavior.

joinableTaskFactory JoinableTaskFactory

The joinable task factory to use when synchronously disposing parts that implement IAsyncDisposable. May be null.

cancellationToken CancellationToken

A token to cancel the operation.

Returns

Task<IExportProviderFactory>

A task whose result is the loaded export provider factory.

LoadExportProviderFactoryAsync(Stream, Resolver, ExportProviderFactoryOptions, CancellationToken)

Loads an export provider factory with optional runtime behavior enabled.

public Task<IExportProviderFactory> LoadExportProviderFactoryAsync(Stream cacheStream, Resolver resolver, ExportProviderFactoryOptions options, CancellationToken cancellationToken)

Parameters

cacheStream Stream

The stream containing the cached composition.

resolver Resolver

The resolver to use when loading the composition.

options ExportProviderFactoryOptions

Options that control export provider behavior.

cancellationToken CancellationToken

A token that may cancel the operation.

Returns

Task<IExportProviderFactory>

The loaded export provider factory.

LoadExportProviderFactoryAsync(Stream, Resolver, JoinableTaskFactory?, CancellationToken)

Creates an IExportProviderFactory for this cached composition.

public Task<IExportProviderFactory> LoadExportProviderFactoryAsync(Stream cacheStream, Resolver resolver, JoinableTaskFactory? joinableTaskFactory, CancellationToken cancellationToken)

Parameters

cacheStream Stream

The stream to read the cached composition from.

resolver Resolver

The resolver to use when loading the composition.

joinableTaskFactory JoinableTaskFactory

The joinable task factory to use when synchronously disposing parts that implement IAsyncDisposable. May be null.

cancellationToken CancellationToken

A token to cancel the operation.

Returns

Task<IExportProviderFactory>

A task whose result is the loaded export provider factory.

LoadExportProviderFactoryAsync(Stream, Resolver, CancellationToken)

public Task<IExportProviderFactory> LoadExportProviderFactoryAsync(Stream cacheStream, Resolver resolver, CancellationToken cancellationToken = default)

Parameters

cacheStream Stream

resolver Resolver

cancellationToken CancellationToken

Returns

Task<IExportProviderFactory>

LoadRuntimeCompositionAsync(Stream, Resolver, CancellationToken)

public Task<RuntimeComposition> LoadRuntimeCompositionAsync(Stream cacheStream, Resolver resolver, CancellationToken cancellationToken = default)

Parameters

cacheStream Stream

resolver Resolver

cancellationToken CancellationToken

Returns

Task<RuntimeComposition>

SaveAsync(CompositionConfiguration, Stream, CancellationToken)

public Task SaveAsync(CompositionConfiguration configuration, Stream cacheStream, CancellationToken cancellationToken = default)

Parameters

configuration CompositionConfiguration

cacheStream Stream

cancellationToken CancellationToken

Returns

Task

SaveAsync(RuntimeComposition, Stream, CancellationToken)

public Task SaveAsync(RuntimeComposition composition, Stream cacheStream, CancellationToken cancellationToken = default)

Parameters

composition RuntimeComposition

cacheStream Stream

cancellationToken CancellationToken

Returns

Task