-
Notifications
You must be signed in to change notification settings - Fork 150
Expand file tree
/
Copy pathIFileProxy.cs
More file actions
106 lines (94 loc) · 4.22 KB
/
IFileProxy.cs
File metadata and controls
106 lines (94 loc) · 4.22 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
// Copyright © 2018 Dmitry Sikorsky. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System;
using System.IO;
using System.Threading.Tasks;
namespace ExtCore.FileStorage.Abstractions;
/// <summary>
/// Describes a generic file proxy to manipulate an underlying file with a specified relative path and a filename.
/// </summary>
public interface IFileProxy
{
/// <summary>
/// The path of the underlying file relatively to the root one.
/// </summary>
string RelativePath { get; }
/// <summary>
/// The filename of the underlying file.
/// </summary>
string Filename { get; }
/// <summary>
/// Checks if the underlying file exists.
/// </summary>
/// <returns>Returns a flag indicating if the underlying file exists.</returns>
Task<bool> ExistsAsync();
/// <summary>
/// Reads content of the underlying file as a stream.
/// </summary>
/// <returns>Content of the underlying file as a stream.</returns>
/// <exception cref="AccessDeniedException"></exception>
/// <exception cref="DirectoryNotFoundException"></exception>
/// <exception cref="FileNotFoundException"></exception>
/// <exception cref="PathTooLongException"></exception>
/// <exception cref="FileStorageException"></exception>
Task<Stream> ReadStreamAsync();
/// <summary>
/// Reads content of the underlying file as a byte array.
/// </summary>
/// <returns>Content of the underlying file as a byte array.</returns>
/// <exception cref="AccessDeniedException"></exception>
/// <exception cref="DirectoryNotFoundException"></exception>
/// <exception cref="FileNotFoundException"></exception>
/// <exception cref="PathTooLongException"></exception>
/// <exception cref="FileStorageException"></exception>
Task<byte[]> ReadBytesAsync();
/// <summary>
/// Reads content of the underlying file as a text string.
/// </summary>
/// <returns>Content of the underlying file as a text string.</returns>
/// <exception cref="AccessDeniedException"></exception>
/// <exception cref="DirectoryNotFoundException"></exception>
/// <exception cref="FileNotFoundException"></exception>
/// <exception cref="PathTooLongException"></exception>
/// <exception cref="FileStorageException"></exception>
Task<string> ReadTextAsync();
/// <summary>
/// Writes content to the underlying file as a stream.
/// </summary>
/// <param name="inputStream">Content to write to the underlying file as a stream.</param>
/// <exception cref="ArgumentNullException"></exception>
/// <exception cref="AccessDeniedException"></exception>
/// <exception cref="DirectoryNotFoundException"></exception>
/// <exception cref="PathTooLongException"></exception>
/// <exception cref="FileStorageException"></exception>
Task WriteStreamAsync(Stream inputStream);
/// <summary>
/// Writes content to the underlying file as a byte array.
/// </summary>
/// <param name="bytes">Content to write to the underlying file as a byte array.</param>
/// <exception cref="ArgumentNullException"></exception>
/// <exception cref="AccessDeniedException"></exception>
/// <exception cref="DirectoryNotFoundException"></exception>
/// <exception cref="PathTooLongException"></exception>
/// <exception cref="FileStorageException"></exception>
Task WriteBytesAsync(byte[] bytes);
/// <summary>
/// Writes content to the underlying file as a text string.
/// </summary>
/// <param name="text">Content to write to the underlying file as a text string.</param>
/// <exception cref="ArgumentNullException"></exception>
/// <exception cref="AccessDeniedException"></exception>
/// <exception cref="DirectoryNotFoundException"></exception>
/// <exception cref="PathTooLongException"></exception>
/// <exception cref="FileStorageException"></exception>
Task WriteTextAsync(string text);
/// <summary>
/// Deletes the underlying file.
/// </summary>
/// <exception cref="AccessDeniedException"></exception>
/// <exception cref="DirectoryNotFoundException"></exception>
/// <exception cref="FileNotFoundException"></exception>
/// <exception cref="PathTooLongException"></exception>
/// <exception cref="FileStorageException"></exception>
Task DeleteAsync();
}