C# Class System.IO.Abstractions.TestingHelpers.MockFile

Inheritance: FileBase
Datei anzeigen Open project: tathamoddie/System.IO.Abstractions Class Usage Examples

Public Methods

Method Description
AppendAllLines ( string path, IEnumerable contents ) : void
AppendAllLines ( string path, IEnumerable contents, Encoding encoding ) : void
AppendAllText ( string path, string contents ) : void
AppendAllText ( string path, string contents, Encoding encoding ) : void
AppendText ( string path ) : StreamWriter
Copy ( string sourceFileName, string destFileName ) : void
Copy ( string sourceFileName, string destFileName, bool overwrite ) : void
Create ( string path ) : Stream
Create ( string path, int bufferSize ) : Stream
Create ( string path, int bufferSize, FileOptions options ) : Stream
Create ( string path, int bufferSize, FileOptions options, FileSecurity fileSecurity ) : Stream
CreateText ( string path ) : StreamWriter
Decrypt ( string path ) : void
Delete ( string path ) : void
Encrypt ( string path ) : void
Exists ( string path ) : bool
GetAccessControl ( string path ) : FileSecurity
GetAccessControl ( string path, AccessControlSections includeSections ) : FileSecurity
GetAttributes ( string path ) : FileAttributes

Gets the FileAttributes of the file on the path.
GetCreationTime ( string path ) : DateTime
GetCreationTimeUtc ( string path ) : DateTime
GetLastAccessTime ( string path ) : DateTime
GetLastAccessTimeUtc ( string path ) : DateTime
GetLastWriteTime ( string path ) : DateTime
GetLastWriteTimeUtc ( string path ) : DateTime
MockFile ( IMockFileDataAccessor mockFileDataAccessor ) : System.Collections.Generic
Move ( string sourceFileName, string destFileName ) : void
Open ( string path, FileMode mode ) : Stream
Open ( string path, FileMode mode, FileAccess access ) : Stream
Open ( string path, FileMode mode, FileAccess access, FileShare share ) : Stream
OpenRead ( string path ) : Stream
OpenText ( string path ) : StreamReader
OpenWrite ( string path ) : Stream
ReadAllBytes ( string path ) : byte[]
ReadAllLines ( string path ) : string[]
ReadAllLines ( string path, Encoding encoding ) : string[]
ReadAllText ( string path ) : string
ReadAllText ( string path, Encoding encoding ) : string
ReadLines ( string path ) : IEnumerable
ReadLines ( string path, Encoding encoding ) : IEnumerable
Replace ( string sourceFileName, string destinationFileName, string destinationBackupFileName ) : void
Replace ( string sourceFileName, string destinationFileName, string destinationBackupFileName, bool ignoreMetadataErrors ) : void
SetAccessControl ( string path, FileSecurity fileSecurity ) : void
SetAttributes ( string path, FileAttributes fileAttributes ) : void
SetCreationTime ( string path, DateTime creationTime ) : void
SetCreationTimeUtc ( string path, DateTime creationTimeUtc ) : void
SetLastAccessTime ( string path, DateTime lastAccessTime ) : void
SetLastAccessTimeUtc ( string path, DateTime lastAccessTimeUtc ) : void
SetLastWriteTime ( string path, DateTime lastWriteTime ) : void
SetLastWriteTimeUtc ( string path, DateTime lastWriteTimeUtc ) : void
WriteAllBytes ( string path, byte bytes ) : void

Creates a new file, writes the specified byte array to the file, and then closes the file. If the target file already exists, it is overwritten.

Given a byte array and a file path, this method opens the specified file, writes the contents of the byte array to the file, and then closes the file.

WriteAllLines ( string path, IEnumerable contents ) : void

Creates a new file, writes a collection of strings to the file, and then closes the file.

If the target file already exists, it is overwritten.

You can use this method to create the contents for a collection class that takes an IEnumerable{T} in its constructor, such as a List{T}, HashSet{T}, or a SortedSet{T} class.

WriteAllLines ( string path, IEnumerable contents, Encoding encoding ) : void

Creates a new file by using the specified encoding, writes a collection of strings to the file, and then closes the file.

If the target file already exists, it is overwritten.

You can use this method to create a file that contains the following: The results of a LINQ to Objects query on the lines of a file, as obtained by using the ReadLines method. The contents of a collection that implements an IEnumerable{T} of strings.

WriteAllLines ( string path, string contents ) : void

Creates a new file, writes the specified string array to the file by using the specified encoding, and then closes the file.

If the target file already exists, it is overwritten.

The default behavior of the WriteAllLines method is to write out data using UTF-8 encoding without a byte order mark (BOM). If it is necessary to include a UTF-8 identifier, such as a byte order mark, at the beginning of a file, use the FileBase.WriteAllLines(string,string[],System.Text.Encoding) method overload with UTF8Encoding encoding.

Given a string array and a file path, this method opens the specified file, writes the string array to the file using the specified encoding, and then closes the file.

WriteAllLines ( string path, string contents, Encoding encoding ) : void

Creates a new file, writes the specified string array to the file by using the specified encoding, and then closes the file.

If the target file already exists, it is overwritten.

Given a string array and a file path, this method opens the specified file, writes the string array to the file using the specified encoding, and then closes the file.

WriteAllText ( string path, string contents ) : void

Creates a new file, writes the specified string to the file using the specified encoding, and then closes the file. If the target file already exists, it is overwritten.

This method uses UTF-8 encoding without a Byte-Order Mark (BOM), so using the M:Encoding.GetPreamble method will return an empty byte array. If it is necessary to include a UTF-8 identifier, such as a byte order mark, at the beginning of a file, use the FileBase.WriteAllText(string,string,System.Text.Encoding) method overload with UTF8Encoding encoding.

Given a string and a file path, this method opens the specified file, writes the string to the file, and then closes the file.

WriteAllText ( string path, string contents, Encoding encoding ) : void

Creates a new file, writes the specified string to the file using the specified encoding, and then closes the file. If the target file already exists, it is overwritten.

Given a string and a file path, this method opens the specified file, writes the string to the file using the specified encoding, and then closes the file. The file handle is guaranteed to be closed by this method, even if exceptions are raised.

Private Methods

Method Description
GetTimeFromFile ( string path, DateTime>.Func existingFileFunction, Func nonExistingFileFunction ) : DateTime
ReadAllBytes ( byte contents, Encoding encoding ) : string
ReadAllTextInternal ( string path, Encoding encoding ) : string
VerifyDirectoryExists ( string path ) : void
VerifyValueIsNotNull ( object value, string parameterName ) : void

Method Details

AppendAllLines() public method

public AppendAllLines ( string path, IEnumerable contents ) : void
path string
contents IEnumerable
return void

AppendAllLines() public method

public AppendAllLines ( string path, IEnumerable contents, Encoding encoding ) : void
path string
contents IEnumerable
encoding System.Text.Encoding
return void

AppendAllText() public method

public AppendAllText ( string path, string contents ) : void
path string
contents string
return void

AppendAllText() public method

public AppendAllText ( string path, string contents, Encoding encoding ) : void
path string
contents string
encoding System.Text.Encoding
return void

AppendText() public method

public AppendText ( string path ) : StreamWriter
path string
return StreamWriter

Copy() public method

public Copy ( string sourceFileName, string destFileName ) : void
sourceFileName string
destFileName string
return void

Copy() public method

public Copy ( string sourceFileName, string destFileName, bool overwrite ) : void
sourceFileName string
destFileName string
overwrite bool
return void

Create() public method

public Create ( string path ) : Stream
path string
return Stream

Create() public method

public Create ( string path, int bufferSize ) : Stream
path string
bufferSize int
return Stream

Create() public method

public Create ( string path, int bufferSize, FileOptions options ) : Stream
path string
bufferSize int
options FileOptions
return Stream

Create() public method

public Create ( string path, int bufferSize, FileOptions options, FileSecurity fileSecurity ) : Stream
path string
bufferSize int
options FileOptions
fileSecurity System.Security.AccessControl.FileSecurity
return Stream

CreateText() public method

public CreateText ( string path ) : StreamWriter
path string
return StreamWriter

Decrypt() public method

public Decrypt ( string path ) : void
path string
return void

Delete() public method

public Delete ( string path ) : void
path string
return void

Encrypt() public method

public Encrypt ( string path ) : void
path string
return void

Exists() public method

public Exists ( string path ) : bool
path string
return bool

GetAccessControl() public method

public GetAccessControl ( string path ) : FileSecurity
path string
return System.Security.AccessControl.FileSecurity

GetAccessControl() public method

public GetAccessControl ( string path, AccessControlSections includeSections ) : FileSecurity
path string
includeSections AccessControlSections
return System.Security.AccessControl.FileSecurity

GetAttributes() public method

Gets the FileAttributes of the file on the path.
is empty, contains only white spaces, or contains invalid characters. The specified path, file name, or both exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters. is in an invalid format. represents a file and is invalid, such as being on an unmapped drive, or the file cannot be found. represents a directory and is invalid, such as being on an unmapped drive, or the directory cannot be found. This file is being used by another process. The caller does not have the required permission.
public GetAttributes ( string path ) : FileAttributes
path string The path to the file.
return FileAttributes

GetCreationTime() public method

public GetCreationTime ( string path ) : DateTime
path string
return DateTime

GetCreationTimeUtc() public method

public GetCreationTimeUtc ( string path ) : DateTime
path string
return DateTime

GetLastAccessTime() public method

public GetLastAccessTime ( string path ) : DateTime
path string
return DateTime

GetLastAccessTimeUtc() public method

public GetLastAccessTimeUtc ( string path ) : DateTime
path string
return DateTime

GetLastWriteTime() public method

public GetLastWriteTime ( string path ) : DateTime
path string
return DateTime

GetLastWriteTimeUtc() public method

public GetLastWriteTimeUtc ( string path ) : DateTime
path string
return DateTime

MockFile() public method

public MockFile ( IMockFileDataAccessor mockFileDataAccessor ) : System.Collections.Generic
mockFileDataAccessor IMockFileDataAccessor
return System.Collections.Generic

Move() public method

public Move ( string sourceFileName, string destFileName ) : void
sourceFileName string
destFileName string
return void

Open() public method

public Open ( string path, FileMode mode ) : Stream
path string
mode FileMode
return Stream

Open() public method

public Open ( string path, FileMode mode, FileAccess access ) : Stream
path string
mode FileMode
access FileAccess
return Stream

Open() public method

public Open ( string path, FileMode mode, FileAccess access, FileShare share ) : Stream
path string
mode FileMode
access FileAccess
share FileShare
return Stream

OpenRead() public method

public OpenRead ( string path ) : Stream
path string
return Stream

OpenText() public method

public OpenText ( string path ) : StreamReader
path string
return StreamReader

OpenWrite() public method

public OpenWrite ( string path ) : Stream
path string
return Stream

ReadAllBytes() public method

public ReadAllBytes ( string path ) : byte[]
path string
return byte[]

ReadAllLines() public method

public ReadAllLines ( string path ) : string[]
path string
return string[]

ReadAllLines() public method

public ReadAllLines ( string path, Encoding encoding ) : string[]
path string
encoding System.Text.Encoding
return string[]

ReadAllText() public method

public ReadAllText ( string path ) : string
path string
return string

ReadAllText() public method

public ReadAllText ( string path, Encoding encoding ) : string
path string
encoding System.Text.Encoding
return string

ReadLines() public method

public ReadLines ( string path ) : IEnumerable
path string
return IEnumerable

ReadLines() public method

public ReadLines ( string path, Encoding encoding ) : IEnumerable
path string
encoding System.Text.Encoding
return IEnumerable

Replace() public method

public Replace ( string sourceFileName, string destinationFileName, string destinationBackupFileName ) : void
sourceFileName string
destinationFileName string
destinationBackupFileName string
return void

Replace() public method

public Replace ( string sourceFileName, string destinationFileName, string destinationBackupFileName, bool ignoreMetadataErrors ) : void
sourceFileName string
destinationFileName string
destinationBackupFileName string
ignoreMetadataErrors bool
return void

SetAccessControl() public method

public SetAccessControl ( string path, FileSecurity fileSecurity ) : void
path string
fileSecurity System.Security.AccessControl.FileSecurity
return void

SetAttributes() public method

public SetAttributes ( string path, FileAttributes fileAttributes ) : void
path string
fileAttributes FileAttributes
return void

SetCreationTime() public method

public SetCreationTime ( string path, DateTime creationTime ) : void
path string
creationTime DateTime
return void

SetCreationTimeUtc() public method

public SetCreationTimeUtc ( string path, DateTime creationTimeUtc ) : void
path string
creationTimeUtc DateTime
return void

SetLastAccessTime() public method

public SetLastAccessTime ( string path, DateTime lastAccessTime ) : void
path string
lastAccessTime DateTime
return void

SetLastAccessTimeUtc() public method

public SetLastAccessTimeUtc ( string path, DateTime lastAccessTimeUtc ) : void
path string
lastAccessTimeUtc DateTime
return void

SetLastWriteTime() public method

public SetLastWriteTime ( string path, DateTime lastWriteTime ) : void
path string
lastWriteTime DateTime
return void

SetLastWriteTimeUtc() public method

public SetLastWriteTimeUtc ( string path, DateTime lastWriteTimeUtc ) : void
path string
lastWriteTimeUtc DateTime
return void

WriteAllBytes() public method

Creates a new file, writes the specified byte array to the file, and then closes the file. If the target file already exists, it is overwritten.
Given a byte array and a file path, this method opens the specified file, writes the contents of the byte array to the file, and then closes the file.
is a zero-length string, contains only white space, or contains one or more invalid characters as defined by . is or contents is empty. /// The specified path, file name, or both exceed the system-defined maximum length. /// For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters. /// The specified path is invalid (for example, it is on an unmapped drive). An I/O error occurred while opening the file. /// path specified a file that is read-only. /// -or- /// This operation is not supported on the current platform. /// -or- /// path specified a directory. /// -or- /// The caller does not have the required permission. /// The file specified in was not found. is in an invalid format. The caller does not have the required permission.
public WriteAllBytes ( string path, byte bytes ) : void
path string The file to write to.
bytes byte The bytes to write to the file.
return void

WriteAllLines() public method

Creates a new file, writes a collection of strings to the file, and then closes the file.

If the target file already exists, it is overwritten.

You can use this method to create the contents for a collection class that takes an IEnumerable{T} in its constructor, such as a List{T}, HashSet{T}, or a SortedSet{T} class.

is a zero-length string, contains only white space, or contains one or more invalid characters as defined by . Either or is . The specified path is invalid (for example, it is on an unmapped drive). The file specified in was not found. An I/O error occurred while opening the file. /// The specified path, file name, or both exceed the system-defined maximum length. /// For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters. /// is in an invalid format. The caller does not have the required permission. /// specified a file that is read-only. /// -or- /// This operation is not supported on the current platform. /// -or- /// specified a directory. /// -or- /// The caller does not have the required permission. ///
public WriteAllLines ( string path, IEnumerable contents ) : void
path string The file to write to.
contents IEnumerable The lines to write to the file.
return void

WriteAllLines() public method

Creates a new file by using the specified encoding, writes a collection of strings to the file, and then closes the file.

If the target file already exists, it is overwritten.

You can use this method to create a file that contains the following: The results of a LINQ to Objects query on the lines of a file, as obtained by using the ReadLines method. The contents of a collection that implements an IEnumerable{T} of strings.

is a zero-length string, contains only white space, or contains one or more invalid characters as defined by . Either , , or is . The specified path is invalid (for example, it is on an unmapped drive). The file specified in was not found. An I/O error occurred while opening the file. /// The specified path, file name, or both exceed the system-defined maximum length. /// For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters. /// is in an invalid format. The caller does not have the required permission. /// specified a file that is read-only. /// -or- /// This operation is not supported on the current platform. /// -or- /// specified a directory. /// -or- /// The caller does not have the required permission. ///
public WriteAllLines ( string path, IEnumerable contents, Encoding encoding ) : void
path string The file to write to.
contents IEnumerable The lines to write to the file.
encoding System.Text.Encoding The character encoding to use.
return void

WriteAllLines() public method

Creates a new file, writes the specified string array to the file by using the specified encoding, and then closes the file.

If the target file already exists, it is overwritten.

The default behavior of the WriteAllLines method is to write out data using UTF-8 encoding without a byte order mark (BOM). If it is necessary to include a UTF-8 identifier, such as a byte order mark, at the beginning of a file, use the FileBase.WriteAllLines(string,string[],System.Text.Encoding) method overload with UTF8Encoding encoding.

Given a string array and a file path, this method opens the specified file, writes the string array to the file using the specified encoding, and then closes the file.

is a zero-length string, contains only white space, or contains one or more invalid characters as defined by . Either or is . /// The specified path, file name, or both exceed the system-defined maximum length. /// For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters. /// The specified path is invalid (for example, it is on an unmapped drive). An I/O error occurred while opening the file. /// specified a file that is read-only. /// -or- /// This operation is not supported on the current platform. /// -or- /// specified a directory. /// -or- /// The caller does not have the required permission. /// The file specified in was not found. is in an invalid format. The caller does not have the required permission.
public WriteAllLines ( string path, string contents ) : void
path string The file to write to.
contents string The string array to write to the file.
return void

WriteAllLines() public method

Creates a new file, writes the specified string array to the file by using the specified encoding, and then closes the file.

If the target file already exists, it is overwritten.

Given a string array and a file path, this method opens the specified file, writes the string array to the file using the specified encoding, and then closes the file.

is a zero-length string, contains only white space, or contains one or more invalid characters as defined by . Either or is . /// The specified path, file name, or both exceed the system-defined maximum length. /// For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters. /// The specified path is invalid (for example, it is on an unmapped drive). An I/O error occurred while opening the file. /// specified a file that is read-only. /// -or- /// This operation is not supported on the current platform. /// -or- /// specified a directory. /// -or- /// The caller does not have the required permission. /// The file specified in was not found. is in an invalid format. The caller does not have the required permission.
public WriteAllLines ( string path, string contents, Encoding encoding ) : void
path string The file to write to.
contents string The string array to write to the file.
encoding System.Text.Encoding An object that represents the character encoding applied to the string array.
return void

WriteAllText() public method

Creates a new file, writes the specified string to the file using the specified encoding, and then closes the file. If the target file already exists, it is overwritten.
This method uses UTF-8 encoding without a Byte-Order Mark (BOM), so using the M:Encoding.GetPreamble method will return an empty byte array. If it is necessary to include a UTF-8 identifier, such as a byte order mark, at the beginning of a file, use the FileBase.WriteAllText(string,string,System.Text.Encoding) method overload with UTF8Encoding encoding.

Given a string and a file path, this method opens the specified file, writes the string to the file, and then closes the file.

is a zero-length string, contains only white space, or contains one or more invalid characters as defined by . is or contents is empty. /// The specified path, file name, or both exceed the system-defined maximum length. /// For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters. /// The specified path is invalid (for example, it is on an unmapped drive). An I/O error occurred while opening the file. /// path specified a file that is read-only. /// -or- /// This operation is not supported on the current platform. /// -or- /// path specified a directory. /// -or- /// The caller does not have the required permission. /// The file specified in was not found. is in an invalid format. The caller does not have the required permission.
public WriteAllText ( string path, string contents ) : void
path string The file to write to.
contents string The string to write to the file.
return void

WriteAllText() public method

Creates a new file, writes the specified string to the file using the specified encoding, and then closes the file. If the target file already exists, it is overwritten.
Given a string and a file path, this method opens the specified file, writes the string to the file using the specified encoding, and then closes the file. The file handle is guaranteed to be closed by this method, even if exceptions are raised.
is a zero-length string, contains only white space, or contains one or more invalid characters as defined by . is or contents is empty. /// The specified path, file name, or both exceed the system-defined maximum length. /// For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters. /// The specified path is invalid (for example, it is on an unmapped drive). An I/O error occurred while opening the file. /// path specified a file that is read-only. /// -or- /// This operation is not supported on the current platform. /// -or- /// path specified a directory. /// -or- /// The caller does not have the required permission. /// The file specified in was not found. is in an invalid format. The caller does not have the required permission.
public WriteAllText ( string path, string contents, Encoding encoding ) : void
path string The file to write to.
contents string The string to write to the file.
encoding System.Text.Encoding The encoding to apply to the string.
return void