Skip to content

Commit 328c816

Browse files
authored
Update README
1 parent f0bf337 commit 328c816

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# FastSearchLibrary
22
The multithreading .NET library that provides opportunity to fast find files or directories using different search criteria.
33

4-
[The MIF](https://github.com/VladPVS/The-MIF "The MIF search tool") file search tool is based on this library. You can [try](https://github.com/VladPVS/The-MIF/releases "Download The MIF") it right now.
4+
[The MIF](https://github.com/VladPVS/The-MIF "The MIF search tool") file search tool is based on this library. You can [try](https://github.com/VladPVS/The-MIF/releases "Download The MIF") it if you want to estimate speed of work right now.
55
#### Works really fast. Check it yourself!
66
![Downloads](https://img.shields.io/github/downloads/VladPVS/FastSearchLibrary/total.svg)
77

@@ -23,7 +23,7 @@ Next classes provide search functionality:
2323

2424
## USE PRINCIPLES
2525
### Basic opportunities
26-
* Classes `FilesSearcher` and `DirectorySearcher` contain static method that allow execute search by different criteria.
26+
* Classes `FilesSearcher` and `DirectorySearcher` contain static methods that allow to execute search by different criteria.
2727
These methods return result only when they fully complete execution.
2828
* Methods that have "Fast" ending divide task on several
2929
subtasks that execute simultaneously in thread pool.
@@ -79,7 +79,7 @@ Next classes provide search functionality:
7979
* `event EventHandler<SearchCompleted> SearchCompleted` - fires when search process is completed or stopped.
8080
Event includes `bool IsCanceled { get; }` property that contains value that defines whether search process stopped by calling
8181
`StopSearch()` method.
82-
To stop search process possibility one have to use constructor that accepts CancellationTokenSource parameter.
82+
To get stop search process possibility one have to use constructor that accepts CancellationTokenSource parameter.
8383

8484
Example:
8585

@@ -140,7 +140,7 @@ Next classes provide search functionality:
140140
`lock` keyword as you can see in example above or use thread safe collection from `System.Collections.Concurrent` namespace.
141141

142142
### Extended opportunities
143-
FileSearcher class includes 2 additional parameters: `handlerOption`, `suppressOperationCanceledException`.
143+
There are 2 additional parameters that one can set. These are `handlerOption` and `suppressOperationCanceledException`.
144144
`ExecuteHandlers handlerOption` parameter represents instance of `ExecuteHandlers` enumeration that specifies where
145145
FilesFound event handlers are executed:
146146
* `InCurrentTask` value means that `FileFound` event handlers will be executed in that task where files were found.
@@ -150,9 +150,9 @@ Next classes provide search functionality:
150150

151151
`bool suppressOperationCanceledException` parameter determines whether necessary to suppress
152152
OperationCanceledException.
153-
If `suppressOperationCanceledException` parameter has value `false` and StopSearch() method calls the `OperationCanceledException`
153+
If `suppressOperationCanceledException` parameter has value `false` and StopSearch() method is called the `OperationCanceledException`
154154
will be thrown. In this case you have to process the exception manually.
155-
If `suppressOperationCanceledException` parameter has value `true` and StopSearch() method calls the `OperationCanceledException`
155+
If `suppressOperationCanceledException` parameter has value `true` and StopSearch() method is called the `OperationCanceledException`
156156
is processed automatically and you don't need to catch it.
157157
Default value is `true`.
158158

0 commit comments

Comments
 (0)