CaseInSensitiveSortHookFn hook function for case insensitive directory traversal.

CaseSensitiveSortHookFn hook function for case sensitive directory traversal.

DefaultExtendHookFn is the default extend hook function.

GetDefaultOptions.

InitFiltersHookFn is the default filter initialiser.

Lstat is the default Query Status hook function.

NewInvalidNotificationMuteRequestedNativeError creates an untranslated error to indicate invalid notification mute requested (internal error).

NewInvalidPeriscopeRootPathNativeError creates an untranslated error to indicate invalid resume state transition occurred (internal error).

NewItemAlreadyExtendedNativeError creates an untranslated error to indicate invalid resume state transition occurred (internal error).

NewItemAlreadyExtendedNativeError creates an untranslated error to indicate traverse-item already extended (internal error).

NewMissingListenDetacherFunctionNativeError creates an untranslated error to indicate invalid resume state transition occurred (internal error).

NewResumeControllerNotSetNativeError creates an untranslated error to indicate resume controller not set (internal error).

ReadEntriesHookFn reads the contents of a directory.

RootItemSubPathHookFn.

RootParentSubPathHookFn.

Tail extracts the end part of a string, starting from the offset.

DirectoryContentsOrderFilesFirstEn invoke files first.

DirectoryContentsOrderFoldersFirstEn invoke folders first.

FilterTypeCustomEn client definable filter.

FilterTypeExtendedGlobEn is the preferred filter type as it the most user friendly.

FilterTypeGlobEn glob filter.

FilterTypePolyEn poly filter.

FilterTypeRegexEn regex filter.

conditional listening is active (callback is invoked).

listen not active, callback always invoked (subject to filtering).

listen used to resume by fast-forwarding.

conditional listening is awaiting activation.

conditional listening is now deactivated.

MetricNoChildFilesFilteredOutEn represents the number of children files of a particular directory that fail to pass the compound filter when using the folders with files subscription .

MetricNoChildFilesFoundEn represents the number of children files of a particular directory that pass the compound filter when using the folders with files subscription .

MetricNoFilesFilteredOutEn represents the no of files filtered out .

MetricNoFilesInvokedEn represents the no of files invoked for during traversal .

MetricNoFoldersFilteredOutEn represents the no of folders filtered out .

MetricNoFoldersInvokedEn represents the no of folders invoked for during traversal .

ScopeAllEn represents any node type .

ScopeCustomEn, client defined categorisation (yet to be confirmed) .

ScopeFileEn attributed to file nodes .

ScopeFolderEn attributed to directory nodes .

ScopeIntermediateEn, apply filter to nodes which are neither leaf or top nodes .

ScopeLeafEn, for directories, any node that has no sub folders.

ScopeRootEn, the Root scope .

ScopeTopEn, any node that is a direct descendent of the root node .

invoke callback for files and folders.

invoke callback for files only.

invoke callback for folders only.

invoke callback for folders only but include files.

ErrUndefinedSubscriptionType indicates client has not set the navigation subscription type at /Options.Store.Subscription.

CompoundFilter filter used when subscription is FoldersWithFiles.

DirectoryContents represents the contents of a directory's contents and handles sorting order which by default is different between various operating systems.

EnoughAlready when using the universal navigator within a sampling operation, set these accordingly from inside the while predicate to indicate wether the iteration loop should continue to consider more entries to be included in the sample.

EntryQuantities contains specification of no of files and folders used in various contexts, but primarily sampling.

ExtendedItem provides extended information if the client requests it by setting the DoExtend boolean in the traverse options.

Filter base filter struct.

FilterDef defines a filter to be used filtering or listening features.

FilteredInfo used within the sampling process during a traversal; more specifically, they should be set inside the while predicate.

GlobFilter wildcard filter.

ListenTriggers.

Metric.

NavigationBehaviours.

NavigationInfo.

NavigationState carries information about navigation that client may be interested in and permitted to access, as opposed to the navigationFrame which is meant for internal purposes only.

Notifications.

OptionsStore represents that part of options that is directly persist-able.

PersistOptions contains options for persisting traverse options.

PolyFilter is a dual filter that allows files and folders to be filtered independently.

Primary.

RegexFilter regex filter.

Resume represents a traversal that is invoked as a result of the user needing to resume a previously interrupted navigation session.

Resumption.

SamplerOptions.

SortBehaviour.

SubPathBehaviour.

SubPathInfo.

TraverseHooks defines the suite of items that can be customised by the client.

TraverseItem info provided for each file system entity encountered during traversal.

TraverseOptions customise the way a directory tree is traversed.

TraverseResult the result of the traversal process.

CompoundTraverseFilter filter that can be applied to a folder's collection of entries when subscription is.

TraverseFilter filter that can be applied to file system entries.

TraverseNavigator interface to the main traverse instance.

AscendancyHandler defines the signatures of ascend/descend handlers.

BeginHandler life cycle event handler, invoked before start of traversal.

DirectoryContentsOrderEnum determines what order a directories entries are invoked for.

EachDirectoryItemPredicate callback to invoke for each child item.

EndHandler life cycle event handler, invoked at end of traversal.

ExtendHookFn.

FilterInitHookFn.

FilterScopeBiEnum allows client to define which node types should be filtered.

ListenHandler.

ListeningState denotes whether user defined callback is being invoked.

MetricCollection TODO: make this private as it's internal implementation detail.

Lstat function signature that enables the default t be overridden.

ReadDirectoryHookFn hook function to define implementation of how a directory's entries are read.

SampleTypeEnum determines the type of sampling to use.

SortEntriesHookFn hook function to define how directory entries are sorted.

SubPathHookFn.

TraverseCallback defines traversal callback function signature.

TraverseOptionFn functional traverse options.

TraverseSubscription type to define traversal subscription (for which file system items the client defined callback are invoked for).

WhileDirectoryPredicate determines when to terminate the loop.