2020-02-04 01:49:27 +01:00
#pragma warning disable CS1591
2019-01-06 21:50:43 +01:00
using System ;
2018-12-28 00:27:57 +01:00
using System.Collections.Generic ;
namespace MediaBrowser.Model.IO
{
/// <summary>
2020-02-04 01:49:27 +01:00
/// Interface IFileSystem.
2018-12-28 00:27:57 +01:00
/// </summary>
public interface IFileSystem
{
void AddShortcutHandler ( IShortcutHandler handler ) ;
/// <summary>
/// Determines whether the specified filename is shortcut.
/// </summary>
/// <param name="filename">The filename.</param>
/// <returns><c>true</c> if the specified filename is shortcut; otherwise, <c>false</c>.</returns>
bool IsShortcut ( string filename ) ;
/// <summary>
/// Resolves the shortcut.
/// </summary>
/// <param name="filename">The filename.</param>
/// <returns>System.String.</returns>
string ResolveShortcut ( string filename ) ;
/// <summary>
/// Creates the shortcut.
/// </summary>
/// <param name="shortcutPath">The shortcut path.</param>
/// <param name="target">The target.</param>
void CreateShortcut ( string shortcutPath , string target ) ;
string MakeAbsolutePath ( string folderPath , string filePath ) ;
/// <summary>
2019-01-26 23:24:28 +01:00
/// Returns a <see cref="FileSystemMetadata" /> object for the specified file or directory path.
2018-12-28 00:27:57 +01:00
/// </summary>
/// <param name="path">A path to a file or directory.</param>
2019-01-26 23:24:28 +01:00
/// <returns>A <see cref="FileSystemMetadata" /> object.</returns>
/// <remarks>If the specified path points to a directory, the returned <see cref="FileSystemMetadata" /> object's
/// <see cref="FileSystemMetadata.IsDirectory" /> property will be set to true and all other properties will reflect the properties of the directory.</remarks>
2018-12-28 00:27:57 +01:00
FileSystemMetadata GetFileSystemInfo ( string path ) ;
/// <summary>
2019-01-26 23:24:28 +01:00
/// Returns a <see cref="FileSystemMetadata" /> object for the specified file path.
2018-12-28 00:27:57 +01:00
/// </summary>
/// <param name="path">A path to a file.</param>
2019-01-26 23:24:28 +01:00
/// <returns>A <see cref="FileSystemMetadata" /> object.</returns>
/// <remarks><para>If the specified path points to a directory, the returned <see cref="FileSystemMetadata" /> object's
/// <see cref="FileSystemMetadata.IsDirectory" /> property and the <see cref="FileSystemMetadata.Exists" /> property will both be set to false.</para>
/// <para>For automatic handling of files <b>and</b> directories, use <see cref="M:IFileSystem.GetFileSystemInfo(System.String)" />.</para></remarks>
2018-12-28 00:27:57 +01:00
FileSystemMetadata GetFileInfo ( string path ) ;
/// <summary>
2019-01-26 23:24:28 +01:00
/// Returns a <see cref="FileSystemMetadata" /> object for the specified directory path.
2018-12-28 00:27:57 +01:00
/// </summary>
/// <param name="path">A path to a directory.</param>
2019-01-26 23:24:28 +01:00
/// <returns>A <see cref="FileSystemMetadata" /> object.</returns>
/// <remarks><para>If the specified path points to a file, the returned <see cref="FileSystemMetadata" /> object's
/// <see cref="FileSystemMetadata.IsDirectory" /> property will be set to true and the <see cref="FileSystemMetadata.Exists" /> property will be set to false.</para>
/// <para>For automatic handling of files <b>and</b> directories, use <see cref="M:IFileSystem.GetFileSystemInfo(System.String)" />.</para></remarks>
2018-12-28 00:27:57 +01:00
FileSystemMetadata GetDirectoryInfo ( string path ) ;
/// <summary>
/// Gets the valid filename.
/// </summary>
/// <param name="filename">The filename.</param>
/// <returns>System.String.</returns>
string GetValidFilename ( string filename ) ;
/// <summary>
/// Gets the creation time UTC.
/// </summary>
/// <param name="info">The information.</param>
/// <returns>DateTime.</returns>
DateTime GetCreationTimeUtc ( FileSystemMetadata info ) ;
/// <summary>
/// Gets the creation time UTC.
/// </summary>
/// <param name="path">The path.</param>
/// <returns>DateTime.</returns>
DateTime GetCreationTimeUtc ( string path ) ;
/// <summary>
/// Gets the last write time UTC.
/// </summary>
/// <param name="info">The information.</param>
/// <returns>DateTime.</returns>
DateTime GetLastWriteTimeUtc ( FileSystemMetadata info ) ;
/// <summary>
/// Gets the last write time UTC.
/// </summary>
/// <param name="path">The path.</param>
/// <returns>DateTime.</returns>
DateTime GetLastWriteTimeUtc ( string path ) ;
/// <summary>
/// Swaps the files.
/// </summary>
/// <param name="file1">The file1.</param>
/// <param name="file2">The file2.</param>
void SwapFiles ( string file1 , string file2 ) ;
bool AreEqual ( string path1 , string path2 ) ;
/// <summary>
/// Determines whether [contains sub path] [the specified parent path].
/// </summary>
/// <param name="parentPath">The parent path.</param>
/// <param name="path">The path.</param>
/// <returns><c>true</c> if [contains sub path] [the specified parent path]; otherwise, <c>false</c>.</returns>
bool ContainsSubPath ( string parentPath , string path ) ;
/// <summary>
/// Determines whether [is root path] [the specified path].
/// </summary>
/// <param name="path">The path.</param>
/// <returns><c>true</c> if [is root path] [the specified path]; otherwise, <c>false</c>.</returns>
bool IsRootPath ( string path ) ;
/// <summary>
/// Normalizes the path.
/// </summary>
/// <param name="path">The path.</param>
/// <returns>System.String.</returns>
string NormalizePath ( string path ) ;
/// <summary>
/// Gets the file name without extension.
/// </summary>
/// <param name="info">The information.</param>
/// <returns>System.String.</returns>
string GetFileNameWithoutExtension ( FileSystemMetadata info ) ;
/// <summary>
/// Determines whether [is path file] [the specified path].
/// </summary>
/// <param name="path">The path.</param>
/// <returns><c>true</c> if [is path file] [the specified path]; otherwise, <c>false</c>.</returns>
bool IsPathFile ( string path ) ;
/// <summary>
/// Deletes the file.
/// </summary>
/// <param name="path">The path.</param>
void DeleteFile ( string path ) ;
/// <summary>
/// Gets the directories.
/// </summary>
/// <param name="path">The path.</param>
/// <param name="recursive">if set to <c>true</c> [recursive].</param>
/// <returns>IEnumerable<DirectoryInfo>.</returns>
IEnumerable < FileSystemMetadata > GetDirectories ( string path , bool recursive = false ) ;
/// <summary>
/// Gets the files.
/// </summary>
IEnumerable < FileSystemMetadata > GetFiles ( string path , bool recursive = false ) ;
2019-03-07 15:54:30 +01:00
IEnumerable < FileSystemMetadata > GetFiles ( string path , IReadOnlyList < string > extensions , bool enableCaseSensitiveExtensions , bool recursive ) ;
2018-12-28 00:27:57 +01:00
/// <summary>
/// Gets the file system entries.
/// </summary>
/// <param name="path">The path.</param>
/// <param name="recursive">if set to <c>true</c> [recursive].</param>
/// <returns>IEnumerable<FileSystemMetadata>.</returns>
IEnumerable < FileSystemMetadata > GetFileSystemEntries ( string path , bool recursive = false ) ;
/// <summary>
/// Gets the directory paths.
/// </summary>
/// <param name="path">The path.</param>
/// <param name="recursive">if set to <c>true</c> [recursive].</param>
/// <returns>IEnumerable<System.String>.</returns>
IEnumerable < string > GetDirectoryPaths ( string path , bool recursive = false ) ;
/// <summary>
/// Gets the file paths.
/// </summary>
/// <param name="path">The path.</param>
/// <param name="recursive">if set to <c>true</c> [recursive].</param>
/// <returns>IEnumerable<System.String>.</returns>
IEnumerable < string > GetFilePaths ( string path , bool recursive = false ) ;
2019-01-26 23:24:28 +01:00
2018-12-28 00:27:57 +01:00
IEnumerable < string > GetFilePaths ( string path , string [ ] extensions , bool enableCaseSensitiveExtensions , bool recursive ) ;
/// <summary>
/// Gets the file system entry paths.
/// </summary>
/// <param name="path">The path.</param>
/// <param name="recursive">if set to <c>true</c> [recursive].</param>
/// <returns>IEnumerable<System.String>.</returns>
IEnumerable < string > GetFileSystemEntryPaths ( string path , bool recursive = false ) ;
void SetHidden ( string path , bool isHidden ) ;
void SetReadOnly ( string path , bool readOnly ) ;
void SetAttributes ( string path , bool isHidden , bool readOnly ) ;
List < FileSystemMetadata > GetDrives ( ) ;
void SetExecutable ( string path ) ;
}
}