filesystem#
Fully qualified name: carb::filesystem
-
namespace filesystem#
Namespace for Carbonite FileSystem.
Enumerations#
- ChangeAction
Defines change action that is reported to callback function.
- DirectoryItemType
Defines the type of directory item.
- FileStatus
defines the potential states that an open file stream can be in.
- FileWhence
fixed positions in a file that a file pointer can be moved relative to.
- signed char WalkAction
Defines the behavior requested by the callback function.
Functions#
- bool findFiles(const FindFilesArgs &args)
Finds files in a given list of search paths matching a given list of patterns.
Structs#
- DirectoryItemInfo
Defines struct to hold item info during directory walk.
- File
Opaque type for referring to a File instance.
- FileInfo
Information about a file.
- FindFilesArgs
Search parameters passed to findFiles() .
- IFileSystem
Defines a file system for Carbonite.
Typedefs#
- CanonicalFlags
Base type for flags for the IFileSystem::makeCanonicalPathEx2() function.
- FindFilesFlag
Flag type for FindFilesArgs .
- FindFilesOnExcludedFn
Callback invoked when a file matches a pattern matchWildcards and excludeWildcards.
- FindFilesOnFilterNonCanonicalFn
Callback for each encountered file invoked before canonicalization and pattern matching.
- FindFilesOnMatchedFn
Callback invoked when a file matches a pattern matchWildcards and does not match a pattern in excludeWildcards.
- FindFilesOnSearchPathFn
Callback invoked when starting a search in one of the given search paths.
- FindFilesOnSkippedFn
Callback invoked when a file matches does not match a pattern in matchWildcards.
- OnChangeEventFn
Defines the callback function to use when listening to changes on file system.
- SubscriptionId
Type definition of a subscription.
Variables#
- constexpr CanonicalFlags fCanonicalFlagCheckExists
Flag to indicate that the file must also exist in order for the function to succeed.
- constexpr FindFilesFlag kFindFilesFlagMatchStem
When matching wildcards, only match the "stem".
- constexpr FindFilesFlag kFindFilesFlagNone
Default empty flag.
- constexpr FindFilesFlag kFindFilesFlagRecursive
Flag to recursively search directories.
- constexpr FindFilesFlag kFindFilesFlagReplaceEnvironmentVariables
Before walking the filesystem, a text replace is performed on each given search path. The token
${MY_ENV_VAR}would be replaced with the environment variableMY_ENV_VAR.- const SubscriptionId kInvalidSubscriptionId
Indicates an invalid subscription.