Interface IFileSystem

Interface IFileSystem

Namespace: MediaBrowser.Model.IO

Assembly: MediaBrowser.Model.dll

Syntax

public interface IFileSystem

Properties

CommonFolders

Returns a list of drives and common folders for convienent folder browsing.

Declaration

IEnumerable<FileSystemMetadata> CommonFolders { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<FileSystemMetadata>

DefaultDirectory

Declaration

string DefaultDirectory { get; }

Property Value

Type	Description
System.String

DirectorySeparatorChar

Declaration

char DirectorySeparatorChar { get; }

Property Value

Type	Description
System.Char

Methods

AreEqual(ReadOnlySpan<Char>, ReadOnlySpan<Char>)

Declaration

bool AreEqual(ReadOnlySpan<char> path1, ReadOnlySpan<char> path2)

Parameters

Type	Name	Description
System.ReadOnlySpan<System.Char>	path1
System.ReadOnlySpan<System.Char>	path2

Returns

Type	Description
System.Boolean

AreEqual(String, String)

Declaration

bool AreEqual(string path1, string path2)

Parameters

Type	Name	Description
System.String	path1
System.String	path2

Returns

Type	Description
System.Boolean

ContainsSubPath(ReadOnlySpan<Char>, ReadOnlySpan<Char>)

Determines whether [contains sub path] [the specified parent path].

Declaration

bool ContainsSubPath(ReadOnlySpan<char> parentPath, ReadOnlySpan<char> path)

Parameters

Type	Name	Description
System.ReadOnlySpan<System.Char>	parentPath	The parent path.
System.ReadOnlySpan<System.Char>	path	The path.

Returns

Type	Description
System.Boolean	true if [contains sub path] [the specified parent path]; otherwise, false.

ContainsSubPath(String, String)

Declaration

bool ContainsSubPath(string parentPath, string path)

Parameters

Type	Name	Description
System.String	parentPath
System.String	path

Returns

Type	Description
System.Boolean

CopyFile(String, String, Boolean)

Copies the file.

Declaration

void CopyFile(string source, string target, bool overwrite)

Parameters

Type	Name	Description
System.String	source	The source.
System.String	target	The target.
System.Boolean	overwrite	if set to true [overwrite].

CreateDirectory(String)

Creates the directory.

Declaration

void CreateDirectory(string path)

Parameters

Type	Name	Description
System.String	path	The path.

DeleteDirectory(String, Boolean)

Deletes the directory.

Declaration

void DeleteDirectory(string path, bool recursive)

Parameters

Type	Name	Description
System.String	path	The path.
System.Boolean	recursive	if set to true [recursive].

DeleteDirectory(String, Boolean, Boolean)

Declaration

void DeleteDirectory(string path, bool recursive, bool sendToRecycleBin)

Parameters

Type	Name	Description
System.String	path
System.Boolean	recursive
System.Boolean	sendToRecycleBin

DeleteFile(String)

Deletes the file.

Declaration

void DeleteFile(string path)

Parameters

Type	Name	Description
System.String	path	The path.

DeleteFile(String, Boolean)

Declaration

void DeleteFile(string path, bool sendToRecycleBin)

Parameters

Type	Name	Description
System.String	path
System.Boolean	sendToRecycleBin

DirectoryExists(String)

Directories the exists.

Declaration

bool DirectoryExists(string path)

Parameters

Type	Name	Description
System.String	path	The path.

Returns

Type	Description
System.Boolean	true if XXXX, false otherwise.

DirectoryExists(String, FileSystemCredentials)

Declaration

bool DirectoryExists(string path, FileSystemCredentials credentials)

Parameters

Type	Name	Description
System.String	path
FileSystemCredentials	credentials

Returns

Type	Description
System.Boolean

FileExists(String)

Files the exists.

Declaration

bool FileExists(string path)

Parameters

Type	Name	Description
System.String	path	The path.

Returns

Type	Description
System.Boolean	true if XXXX, false otherwise.

FileExists(String, FileSystemCredentials)

Declaration

bool FileExists(string path, FileSystemCredentials credentials)

Parameters

Type	Name	Description
System.String	path
FileSystemCredentials	credentials

Returns

Type	Description
System.Boolean

GetCreationTimeUtc(FileSystemMetadata)

Gets the creation time UTC.

Declaration

DateTimeOffset GetCreationTimeUtc(FileSystemMetadata info)

Parameters

Type	Name	Description
FileSystemMetadata	info	The information.

Returns

Type	Description
System.DateTimeOffset	DateTime.

GetCreationTimeUtc(String)

Gets the creation time UTC.

Declaration

DateTimeOffset GetCreationTimeUtc(string path)

Parameters

Type	Name	Description
System.String	path	The path.

Returns

Type	Description
System.DateTimeOffset	DateTime.

GetDirectories(String, Boolean)

Gets the directories.

Declaration

IEnumerable<FileSystemMetadata> GetDirectories(string path, bool recursive = false)

Parameters

Type	Name	Description
System.String	path	The path.
System.Boolean	recursive	if set to true [recursive].

Returns

Type	Description
System.Collections.Generic.IEnumerable<FileSystemMetadata>	IEnumerable<DirectoryInfo>.

GetDirectoryInfo(String)

Returns a FileSystemMetadata object for the specified directory path.

Declaration

FileSystemMetadata GetDirectoryInfo(string path)

Parameters

Type	Name	Description
System.String	path	A path to a directory.

Returns

Type	Description
FileSystemMetadata	A FileSystemMetadata object.

Remarks

If the specified path points to a file, the returned FileSystemMetadata object's IsDirectory property will be set to true and the Exists property will be set to false.

For automatic handling of files and directories, use GetFileSystemInfo(String).

GetDirectoryInfo(String, FileSystemCredentials)

Declaration

FileSystemMetadata GetDirectoryInfo(string path, FileSystemCredentials credentials)

Parameters

Type	Name	Description
System.String	path
FileSystemCredentials	credentials

Returns

Type	Description
FileSystemMetadata

GetDirectoryName(ReadOnlySpan<Char>)

Declaration

ReadOnlySpan<char> GetDirectoryName(ReadOnlySpan<char> path)

Parameters

Type	Name	Description
System.ReadOnlySpan<System.Char>	path

Returns

Type	Description
System.ReadOnlySpan<System.Char>

GetDirectoryName(String)

Declaration

string GetDirectoryName(string path)

Parameters

Type	Name	Description
System.String	path

Returns

Type	Description
System.String

GetDirectoryPaths(String, Boolean)

Gets the directory paths.

Declaration

IEnumerable<string> GetDirectoryPaths(string path, bool recursive = false)

Parameters

Type	Name	Description
System.String	path	The path.
System.Boolean	recursive	if set to true [recursive].

Returns

Type	Description
System.Collections.Generic.IEnumerable<System.String>	IEnumerable<System.String>.

GetDriveInfo(String)

Declaration

DriveInfo GetDriveInfo(string path)

Parameters

Type	Name	Description
System.String	path

Returns

Type	Description
System.IO.DriveInfo

GetDrives()

Declaration

List<FileSystemMetadata> GetDrives()

Returns

Type	Description
System.Collections.Generic.List<FileSystemMetadata>

GetFileInfo(String)

Returns a FileSystemMetadata object for the specified file path.

Declaration

FileSystemMetadata GetFileInfo(string path)

Parameters

Type	Name	Description
System.String	path	A path to a file.

Returns

Type	Description
FileSystemMetadata	A FileSystemMetadata object.

Remarks

If the specified path points to a directory, the returned FileSystemMetadata object's IsDirectory property and the Exists property will both be set to false.

For automatic handling of files and directories, use GetFileSystemInfo(String).

GetFileNameWithoutExtension(FileSystemMetadata)

Gets the file name without extension.

Declaration

string GetFileNameWithoutExtension(FileSystemMetadata info)

Parameters

Type	Name	Description
FileSystemMetadata	info	The information.

Returns

Type	Description
System.String	System.String.

GetFileNameWithoutExtension(ReadOnlySpan<Char>)

Gets the file name without extension.

Declaration

ReadOnlySpan<char> GetFileNameWithoutExtension(ReadOnlySpan<char> path)

Parameters

Type	Name	Description
System.ReadOnlySpan<System.Char>	path	The path.

Returns

Type	Description
System.ReadOnlySpan<System.Char>	System.String.

GetFileNameWithoutExtension(String)

Declaration

string GetFileNameWithoutExtension(string path)

Parameters

Type	Name	Description
System.String	path

Returns

Type	Description
System.String

GetFilePaths(String, Boolean)

Gets the file paths.

Declaration

IEnumerable<string> GetFilePaths(string path, bool recursive = false)

Parameters

Type	Name	Description
System.String	path	The path.
System.Boolean	recursive	if set to true [recursive].

Returns

Type	Description
System.Collections.Generic.IEnumerable<System.String>	IEnumerable<System.String>.

GetFilePaths(String, String[], Boolean, Boolean)

Declaration

IEnumerable<string> GetFilePaths(string path, string[] extensions, bool enableCaseSensitiveExtensions, bool recursive)

Parameters

Type	Name	Description
System.String	path
System.String[]	extensions
System.Boolean	enableCaseSensitiveExtensions
System.Boolean	recursive

Returns

Type	Description
System.Collections.Generic.IEnumerable<System.String>

GetFiles(String, Boolean)

Gets the files.

Declaration

IEnumerable<FileSystemMetadata> GetFiles(string path, bool recursive = false)

Parameters

Type	Name	Description
System.String	path
System.Boolean	recursive

Returns

Type	Description
System.Collections.Generic.IEnumerable<FileSystemMetadata>

GetFiles(String, String[], Boolean, Boolean)

Declaration

IEnumerable<FileSystemMetadata> GetFiles(string path, string[] extensions, bool enableCaseSensitiveExtensions, bool recursive)

Parameters

Type	Name	Description
System.String	path
System.String[]	extensions
System.Boolean	enableCaseSensitiveExtensions
System.Boolean	recursive

Returns

Type	Description
System.Collections.Generic.IEnumerable<FileSystemMetadata>

GetFileStream(String, FileOpenMode, FileAccessMode, FileOpenOptions)

Declaration

Stream GetFileStream(string path, FileOpenMode mode, FileAccessMode access, FileOpenOptions fileOpenOptions)

Parameters

Type	Name	Description
System.String	path
FileOpenMode	mode
FileAccessMode	access
FileOpenOptions	fileOpenOptions

Returns

Type	Description
System.IO.Stream

GetFileStream(String, FileOpenMode, FileAccessMode, FileOpenOptions, Int64)

Declaration

Stream GetFileStream(string path, FileOpenMode mode, FileAccessMode access, FileOpenOptions fileOpenOptions, long preAllocationSize)

Parameters

Type	Name	Description
System.String	path
FileOpenMode	mode
FileAccessMode	access
FileOpenOptions	fileOpenOptions
System.Int64	preAllocationSize

Returns

Type	Description
System.IO.Stream

GetFileStream(String, FileOpenMode, FileAccessMode, FileShareMode, FileOpenOptions)

Declaration

Stream GetFileStream(string path, FileOpenMode mode, FileAccessMode access, FileShareMode share, FileOpenOptions fileOpenOptions)

Parameters

Type	Name	Description
System.String	path
FileOpenMode	mode
FileAccessMode	access
FileShareMode	share
FileOpenOptions	fileOpenOptions

Returns

Type	Description
System.IO.Stream

GetFileStream(String, FileOpenMode, FileAccessMode, FileShareMode, FileOpenOptions, Int64)

Declaration

Stream GetFileStream(string path, FileOpenMode mode, FileAccessMode access, FileShareMode share, FileOpenOptions fileOpenOptions, long preAllocationSize)

Parameters

Type	Name	Description
System.String	path
FileOpenMode	mode
FileAccessMode	access
FileShareMode	share
FileOpenOptions	fileOpenOptions
System.Int64	preAllocationSize

Returns

Type	Description
System.IO.Stream

GetFileStream(String, FileOpenMode, FileAccessMode, FileShareMode, Boolean)

Gets the file stream.

Declaration

Stream GetFileStream(string path, FileOpenMode mode, FileAccessMode access, FileShareMode share, bool isAsync = false)

Parameters

Type	Name	Description
System.String	path	The path.
FileOpenMode	mode	The mode.
FileAccessMode	access	The access.
FileShareMode	share	The share.
System.Boolean	isAsync	if set to true [is asynchronous].

Returns

Type	Description
System.IO.Stream	FileStream.

GetFileStream(String, FileOpenMode, FileAccessMode, FileShareMode, Int32, FileOpenOptions)

Declaration

Stream GetFileStream(string path, FileOpenMode mode, FileAccessMode access, FileShareMode share, int bufferSize, FileOpenOptions fileOpenOptions)

Parameters

Type	Name	Description
System.String	path
FileOpenMode	mode
FileAccessMode	access
FileShareMode	share
System.Int32	bufferSize
FileOpenOptions	fileOpenOptions

Returns

Type	Description
System.IO.Stream

GetFileStream(String, FileOpenMode, FileAccessMode, FileShareMode, Int32, FileOpenOptions, Int64)

Declaration

Stream GetFileStream(string path, FileOpenMode mode, FileAccessMode access, FileShareMode share, int bufferSize, FileOpenOptions fileOpenOptions, long preAllocationSize)

Parameters

Type	Name	Description
System.String	path
FileOpenMode	mode
FileAccessMode	access
FileShareMode	share
System.Int32	bufferSize
FileOpenOptions	fileOpenOptions
System.Int64	preAllocationSize

Returns

Type	Description
System.IO.Stream

GetFileStream(String, FileOpenMode, FileAccessMode, Boolean)

Declaration

Stream GetFileStream(string path, FileOpenMode mode, FileAccessMode access, bool isAsync = false)

Parameters

Type	Name	Description
System.String	path
FileOpenMode	mode
FileAccessMode	access
System.Boolean	isAsync

Returns

Type	Description
System.IO.Stream

GetFileSystemEntries(String, Boolean, FileSystemCredentials)

Gets the file system entries.

Declaration

IEnumerable<FileSystemMetadata> GetFileSystemEntries(string path, bool recursive = false, FileSystemCredentials credentials = null)

Parameters

Type	Name	Description
System.String	path	The path.
System.Boolean	recursive	if set to true [recursive].
FileSystemCredentials	credentials

Returns

Type	Description
System.Collections.Generic.IEnumerable<FileSystemMetadata>	IEnumerable<FileSystemMetadata>.

GetFileSystemEntryPaths(String, Boolean)

Gets the file system entry paths.

Declaration

IEnumerable<string> GetFileSystemEntryPaths(string path, bool recursive = false)

Parameters

Type	Name	Description
System.String	path	The path.
System.Boolean	recursive	if set to true [recursive].

Returns

Type	Description
System.Collections.Generic.IEnumerable<System.String>	IEnumerable<System.String>.

GetFileSystemInfo(String)

Returns a FileSystemMetadata object for the specified file or directory path.

Declaration

FileSystemMetadata GetFileSystemInfo(string path)

Parameters

Type	Name	Description
System.String	path	A path to a file or directory.

Returns

Type	Description
FileSystemMetadata	A FileSystemMetadata object.

Remarks

If the specified path points to a directory, the returned FileSystemMetadata object's IsDirectory property will be set to true and all other properties will reflect the properties of the directory.

GetFullPath(String)

Declaration

string GetFullPath(string path)

Parameters

Type	Name	Description
System.String	path

Returns

Type	Description
System.String

GetLastWriteTimeUtc(FileSystemMetadata)

Gets the last write time UTC.

Declaration

DateTimeOffset GetLastWriteTimeUtc(FileSystemMetadata info)

Parameters

Type	Name	Description
FileSystemMetadata	info	The information.

Returns

Type	Description
System.DateTimeOffset	DateTime.

GetLastWriteTimeUtc(String)

Gets the last write time UTC.

Declaration

DateTimeOffset GetLastWriteTimeUtc(string path)

Parameters

Type	Name	Description
System.String	path	The path.

Returns

Type	Description
System.DateTimeOffset	DateTime.

GetLastWriteTimeUtc(String, Boolean)

Declaration

DateTimeOffset GetLastWriteTimeUtc(string path, bool fileExists)

Parameters

Type	Name	Description
System.String	path
System.Boolean	fileExists

Returns

Type	Description
System.DateTimeOffset

GetValidFilename(String)

Gets the valid filename.

Declaration

string GetValidFilename(string filename)

Parameters

Type	Name	Description
System.String	filename	The filename.

Returns

Type	Description
System.String	System.String.

IsPathFile(ReadOnlySpan<Char>)

Determines whether [is path file] [the specified path].

Declaration

bool IsPathFile(ReadOnlySpan<char> path)

Parameters

Type	Name	Description
System.ReadOnlySpan<System.Char>	path	The path.

Returns

Type	Description
System.Boolean	true if [is path file] [the specified path]; otherwise, false.

IsRootPath(ReadOnlySpan<Char>)

Determines whether [is root path] [the specified path].

Declaration

bool IsRootPath(ReadOnlySpan<char> path)

Parameters

Type	Name	Description
System.ReadOnlySpan<System.Char>	path	The path.

Returns

Type	Description
System.Boolean	true if [is root path] [the specified path]; otherwise, false.

MakeAbsolutePath(ReadOnlySpan<Char>, ReadOnlySpan<Char>)

Declaration

ReadOnlySpan<char> MakeAbsolutePath(ReadOnlySpan<char> folderPath, ReadOnlySpan<char> filePath)

Parameters

Type	Name	Description
System.ReadOnlySpan<System.Char>	folderPath
System.ReadOnlySpan<System.Char>	filePath

Returns

Type	Description
System.ReadOnlySpan<System.Char>

MoveDirectory(String, String)

Moves the directory.

Declaration

void MoveDirectory(string source, string target)

Parameters

Type	Name	Description
System.String	source	The source.
System.String	target	The target.

MoveFile(String, String)

Moves the file.

Declaration

void MoveFile(string source, string target)

Parameters

Type	Name	Description
System.String	source	The source.
System.String	target	The target.

MoveFile(String, String, Boolean)

Declaration

void MoveFile(string source, string target, bool overwrite)

Parameters

Type	Name	Description
System.String	source
System.String	target
System.Boolean	overwrite

NormalizeDuplicates(FileSystemMetadata[], Boolean)

Declaration

List<FileSystemMetadata> NormalizeDuplicates(FileSystemMetadata[] paths, bool checkSubPaths)

Parameters

Type	Name	Description
FileSystemMetadata[]	paths
System.Boolean	checkSubPaths

Returns

Type	Description
System.Collections.Generic.List<FileSystemMetadata>

NormalizePath(ReadOnlySpan<Char>)

Normalizes the path.

Declaration

ReadOnlySpan<char> NormalizePath(ReadOnlySpan<char> path)

Parameters

Type	Name	Description
System.ReadOnlySpan<System.Char>	path	The path.

Returns

Type	Description
System.ReadOnlySpan<System.Char>	System.String.

NormalizePath(String)

Declaration

string NormalizePath(string path)

Parameters

Type	Name	Description
System.String	path

Returns

Type	Description
System.String

OpenRead(String)

Opens the read.

Declaration

Stream OpenRead(string path)

Parameters

Type	Name	Description
System.String	path	The path.

Returns

Type	Description
System.IO.Stream	Stream.

ReadAllBytesAsync(String, CancellationToken)

Declaration

Task<byte[]> ReadAllBytesAsync(string path, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	path
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<System.Byte[]>

ReadAllLines(String)

Declaration

string[] ReadAllLines(string path)

Parameters

Type	Name	Description
System.String	path

Returns

Type	Description
System.String[]

ReadAllLinesAsync(String, CancellationToken)

Declaration

Task<string[]> ReadAllLinesAsync(string path, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	path
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task<System.String[]>

ReadAllText(String)

Declaration

string ReadAllText(string path)

Parameters

Type	Name	Description
System.String	path

Returns

Type	Description
System.String

ReadAllTextAsync(String, Encoding, CancellationToken)

Reads all text.

Declaration

Task<string> ReadAllTextAsync(string path, Encoding encoding, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	path	The path.
System.Text.Encoding	encoding	The encoding.
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<System.String>	System.String.

ReadAllTextAsync(String, CancellationToken)

Reads all text.

Declaration

Task<string> ReadAllTextAsync(string path, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	path	The path.
System.Threading.CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
System.Threading.Tasks.Task<System.String>	System.String.

SetAttributes(String, Boolean, Boolean)

Declaration

void SetAttributes(string path, bool isHidden, bool readOnly)

Parameters

Type	Name	Description
System.String	path
System.Boolean	isHidden
System.Boolean	readOnly

SetCreationTimeUtc(String, DateTimeOffset)

Declaration

void SetCreationTimeUtc(string path, DateTimeOffset creationTimeUtc)

Parameters

Type	Name	Description
System.String	path
System.DateTimeOffset	creationTimeUtc

SetExecutable(String)

Declaration

void SetExecutable(string path)

Parameters

Type	Name	Description
System.String	path

SetHidden(String, Boolean)

Declaration

void SetHidden(string path, bool isHidden)

Parameters

Type	Name	Description
System.String	path
System.Boolean	isHidden

SetLastWriteTimeUtc(String, DateTimeOffset)

Declaration

void SetLastWriteTimeUtc(string path, DateTimeOffset lastWriteTimeUtc)

Parameters

Type	Name	Description
System.String	path
System.DateTimeOffset	lastWriteTimeUtc

SetReadOnly(String, Boolean)

Declaration

void SetReadOnly(string path, bool readOnly)

Parameters

Type	Name	Description
System.String	path
System.Boolean	readOnly

SupportsPathNatively(String)

Declaration

bool SupportsPathNatively(string path)

Parameters

Type	Name	Description
System.String	path

Returns

Type	Description
System.Boolean

SwapFiles(String, String)

Swaps the files.

Declaration

void SwapFiles(string file1, string file2)

Parameters

Type	Name	Description
System.String	file1	The file1.
System.String	file2	The file2.

WriteAllBytes(String, Byte[])

Declaration

void WriteAllBytes(string path, byte[] bytes)

Parameters

Type	Name	Description
System.String	path
System.Byte[]	bytes

WriteAllBytesAsync(String, Byte[], CancellationToken)

Declaration

Task WriteAllBytesAsync(string path, byte[] bytes, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	path
System.Byte[]	bytes
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

WriteAllLines(String, IEnumerable<String>)

Declaration

void WriteAllLines(string path, IEnumerable<string> lines)

Parameters

Type	Name	Description
System.String	path
System.Collections.Generic.IEnumerable<System.String>	lines

WriteAllText(String, String)

Writes all text.

Declaration

void WriteAllText(string path, string text)

Parameters

Type	Name	Description
System.String	path	The path.
System.String	text	The text.

WriteAllText(String, String, Encoding)

Writes all text.

Declaration

void WriteAllText(string path, string text, Encoding encoding)

Parameters

Type	Name	Description
System.String	path	The path.
System.String	text	The text.
System.Text.Encoding	encoding	The encoding.

WriteAllTextAsync(String, String, Encoding, CancellationToken)

Declaration

Task WriteAllTextAsync(string path, string text, Encoding encoding, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	path
System.String	text
System.Text.Encoding	encoding
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

WriteAllTextAsync(String, String, CancellationToken)

Declaration

Task WriteAllTextAsync(string path, string text, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
System.String	path
System.String	text
System.Threading.CancellationToken	cancellationToken

Returns

Type	Description
System.Threading.Tasks.Task

Extension Methods

Extensions.JsonClone<T>(T, IJsonSerializer)