Skip to content
ConsoleMonster
Class

FileOperationOptions

ConsoleMonster.FileSystem

Edit on GitHub
Namespace
ConsoleMonster.FileSystem
Assembly
ConsoleMonster
Source
FileOperationTypes.cs:85
Modifiers
sealed

Options for a FileOperation.

Inheritance

  • object
  • FileOperationOptions

Usage

Explore 40 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 15

Accepted by parameters 25

Constructors

public FileOperationOptions() #
FileOperationTypes.cs:85

Properties

public FileConflictPolicy ConflictPolicy { get; set; } #
FileOperationTypes.cs:89

What happens when a destination file exists. The default asks.

public bool PreserveTimestamps { get; set; } #
FileOperationTypes.cs:92

Whether copies keep the source's modification and access times (and creation time where the platform has one). On by default.

public Func<FileConflict, CancellationToken, Task<FileConflictResolution>>? ResolveConflict { get; set; } #
FileOperationTypes.cs:98

Answers a conflict under FileConflictPolicy.Ask. It runs on the operation's worker, so a UI posts the question to its own thread and completes the task with the answer.

public IProgress<FileOperationProgress>? Progress { get; set; } #
FileOperationTypes.cs:101

Receives progress snapshots from the worker: at most once per FileOperationOptions.ProgressInterval, plus each phase change.

public ITrash? Trash { get; set; } #
FileOperationTypes.cs:104

The trash for delete operations; FileTrash.Current when null.

public TimeSpan ProgressInterval { get; set; } #
FileOperationTypes.cs:108

The shortest time between progress reports. The default is 100 ms.

public int BufferSize { get; set; } #
FileOperationTypes.cs:114

The copy buffer in bytes. The default is 1 MiB.

Extension Methods

public static FileOperationOptions BufferSize(FileOperationOptions fileOperationOptions, int value) #

Sets FileOperationOptions.BufferSize: The copy buffer in bytes. The default is 1 MiB.

Parameters

fileOperationOptions ConsoleMonster.FileSystem.FileOperationOptions required
The instance.
value int required
The value.

Returns

FileOperationOptions The same instance.

Examples

// C# initializer or property                                                         // C# fluent
new global::ConsoleMonster.FileSystem.FileOperationOptions { BufferSize = value };    fileOperationOptions.BufferSize(value);
public static FileOperationOptions Configure(FileOperationOptions fileOperationOptions, Action<FileOperationOptions> configure) #

Assigns callbacks and related configuration without invoking delegate-valued properties.

Parameters

fileOperationOptions ConsoleMonster.FileSystem.FileOperationOptions required
The instance.
configure System.Action<ConsoleMonster.FileSystem.FileOperationOptions> required
Assignments applied in order.

Returns

FileOperationOptions The same instance.

Examples

// C# initializer or property                                                              // C# fluent
new global::ConsoleMonster.FileSystem.FileOperationOptions { ResolveConflict = value };    fileOperationOptions.Configure(configured => configured.ResolveConflict = value);
public static FileOperationOptions ConflictPolicy(FileOperationOptions fileOperationOptions, FileConflictPolicy value) #

Sets FileOperationOptions.ConflictPolicy: What happens when a destination file exists. The default asks.

Parameters

fileOperationOptions ConsoleMonster.FileSystem.FileOperationOptions required
The instance.
value ConsoleMonster.FileSystem.FileConflictPolicy required
The value.

Returns

FileOperationOptions The same instance.

Examples

// C# initializer or property                                                             // C# fluent
new global::ConsoleMonster.FileSystem.FileOperationOptions { ConflictPolicy = value };    fileOperationOptions.ConflictPolicy(value);
PreserveTimestamps 2 overloads
public static FileOperationOptions PreserveTimestamps(FileOperationOptions fileOperationOptions, bool value) #

Sets FileOperationOptions.PreserveTimestamps: Whether copies keep the source's modification and access times (and creation time where the platform has one). On by default.

Parameters

fileOperationOptions ConsoleMonster.FileSystem.FileOperationOptions required
The instance.
value bool required
The value.

Returns

FileOperationOptions The same instance.

Examples

// C# initializer or property                                                                 // C# fluent
new global::ConsoleMonster.FileSystem.FileOperationOptions { PreserveTimestamps = value };    fileOperationOptions.PreserveTimestamps(value);
public static FileOperationOptions PreserveTimestamps(FileOperationOptions fileOperationOptions) #

Sets FileOperationOptions.PreserveTimestamps to true.

Parameters

fileOperationOptions ConsoleMonster.FileSystem.FileOperationOptions required
The instance to configure.

Returns

FileOperationOptions The same instance.
public static FileOperationOptions Progress(FileOperationOptions fileOperationOptions, IProgress<FileOperationProgress>? value) #

Sets FileOperationOptions.Progress: Receives progress snapshots from the worker: at most once per FileOperationOptions.ProgressInterval, plus each phase change.

Parameters

fileOperationOptions ConsoleMonster.FileSystem.FileOperationOptions required
The instance.
value System.IProgress<ConsoleMonster.FileSystem.FileOperationProgress>? required
The value.

Returns

FileOperationOptions The same instance.

Examples

// C# initializer or property                                                       // C# fluent
new global::ConsoleMonster.FileSystem.FileOperationOptions { Progress = value };    fileOperationOptions.Progress(value);
public static FileOperationOptions ProgressInterval(FileOperationOptions fileOperationOptions, TimeSpan value) #

Sets FileOperationOptions.ProgressInterval: The shortest time between progress reports. The default is 100 ms.

Parameters

fileOperationOptions ConsoleMonster.FileSystem.FileOperationOptions required
The instance.
value System.TimeSpan required
The value.

Returns

FileOperationOptions The same instance.

Examples

// C# initializer or property                                                               // C# fluent
new global::ConsoleMonster.FileSystem.FileOperationOptions { ProgressInterval = value };    fileOperationOptions.ProgressInterval(value);
public static FileOperationOptions Trash(FileOperationOptions fileOperationOptions, ITrash? value) #

Sets FileOperationOptions.Trash: The trash for delete operations; FileTrash.Current when null.

Parameters

fileOperationOptions ConsoleMonster.FileSystem.FileOperationOptions required
The instance.
value ConsoleMonster.FileSystem.ITrash? required
The value.

Returns

FileOperationOptions The same instance.

Examples

// C# initializer or property                                                    // C# fluent
new global::ConsoleMonster.FileSystem.FileOperationOptions { Trash = value };    fileOperationOptions.Trash(value);