IFileEntitySource Interface

Definition

Exposes a set of methods designed to provide files for the File Enumeration Service's cache.

public interface IFileEntitySource
type IFileEntitySource = interface
Public Interface IFileEntitySource

Examples

[ExportAttribute(typeof(IFileEntitySource))] [VsStateTargetAttribute(OpenedFolder)] // required

Properties

IsDone

Gets whether there are more files to get through GetNextChunkOfEntitiesAsync(CancellationToken) or not.

Methods

GetAdditionalNonCachedFileEntitiesAsync(Guid, Boolean, Boolean, Boolean, PathFilter, CancellationToken)

Enumerates additional items that are not meant to be cached.

GetNextChunkOfEntitiesAsync(CancellationToken)

Gets the next chunk of file system entry that the provider discovers, if possible.

Reset()

Reset the provider, so GetNextChunkOfEntitiesAsync(CancellationToken) restart to provide files from scratch. Generally, this action set IsDone to false, but it isn't mandatory.

TryGetSingleCacheFileEntityAsync(Object, CancellationToken)

Tries to generate a CacheFileEntity from a given raw value.

Applies to