【翻译】Tusdotnet中文文档（3）自定义功能和相关技术

public interface ITusStore
{
/// <summary>
/// 使用提供的流将数据写入文件
/// 如果流的长度超过了上传文件的长度，必须抛出<exception cref="TusStoreException"></exception>异常/// </summary>
/// <param name="fileId">要写入的文件Id</param>
/// <param name="stream">来自客户端的输入流</param>
/// <param name="cancellationToken">取消令牌</param>
/// <returns>写入的字节长度</returns>
Task<long> AppendDataAsync(string fileId, Stream stream, CancellationToken cancellationToken); /// <summary>
/// 检索一个文件是否存在
/// </summary>
/// <param name="fileId">要检查的文件Id</param>
/// <param name="cancellationToken">取消令牌.</param>
/// <returns></returns>
Task<bool> FileExistAsync(string fileId, CancellationToken cancellationToken); /// <summary>
/// Returns the upload length specified when the file was created or null if Defer-Upload-Lenght was used.
/// </summary>
/// <param name="fileId">The id of the file to check.</param>
/// <param name="cancellationToken">Cancellation token to use when cancelling.</param>
/// <returns>The upload length of the file</returns>
Task<long?> GetUploadLengthAsync(string fileId, CancellationToken cancellationToken); /// <summary>
/// Returns the current size of the file a.k.a. the upload offset.
/// </summary>
/// <param name="fileId">The id of the file to check.</param>
/// <param name="cancellationToken">Cancellation token to use when cancelling.</param>
/// <returns>The size of the current file</returns>
Task<long> GetUploadOffsetAsync(string fileId, CancellationToken cancellationToken);
}

public interface ITusChecksumStore
{
/// <summary>
/// Returns a collection of hash algorithms that the store supports (e.g. sha1).
/// </summary>
/// <param name="cancellationToken">Cancellation token to use when cancelling</param>
/// <returns>The collection of hash algorithms</returns>
Task<IEnumerable<string>> GetSupportedAlgorithmsAsync(CancellationToken cancellationToken); /// <summary>
/// Verify that the provided checksum matches the file checksum.
/// </summary>
/// <param name="fileId">The id of the file to check</param>
/// <param name="algorithm">The checksum algorithm to use when checking. This algorithm must be supported by the store.</param>
/// <param name="checksum">The checksom to use for verification</param>
/// <param name="cancellationToken">Cancellation token to use when cancelling</param>
/// <returns>True if the checksum matches otherwise false</returns>
Task<bool> VerifyChecksumAsync(string fileId, string algorithm, byte[] checksum, CancellationToken cancellationToken);
}

public interface ITusConcatenationStore
{
/// <summary>
/// Returns the type of Upload-Concat header that was used when creating the file.
/// Returns null if no Upload-Concat was used.
/// </summary>
/// <param name="fileId">The file to check</param>
/// <param name="cancellationToken">Cancellation token to use when cancelling</param>
/// <returns>FileConcatPartial, FileConcatFinal or null</returns>
Task<FileConcat> GetUploadConcatAsync(string fileId, CancellationToken cancellationToken); /// <summary>
/// Create a partial file. This method is called when a Upload-Concat header is present and when its value is "partial".
/// </summary>
/// <param name="uploadLength">The length of the upload in bytes</param>
/// <param name="metadata">The Upload-Metadata request header or null if no header was provided</param>
/// <param name="cancellationToken">Cancellation token to use when cancelling</param>
/// <returns>The id of the newly created file</returns>
Task<string> CreatePartialFileAsync(long uploadLength, string metadata, CancellationToken cancellationToken); /// <summary>
/// Creates a final file by concatenating multiple files together. This method is called when a Upload-Concat header
/// is present with a "final" value.
/// </summary>
/// <param name="partialFiles">List of file ids to concatenate</param>
/// <param name="metadata">The Upload-Metadata request header or null if no header was provided</param>
/// <param name="cancellationToken">Cancellation token to use when cancelling</param>
/// <returns>The id of the newly created file</returns>
Task<string> CreateFinalFileAsync(string[] partialFiles, string metadata, CancellationToken cancellationToken);
}

public interface ITusCreationStore
{
/// <summary>
/// Create a file upload reference that can later be used to upload data.
/// </summary>
/// <param name="uploadLength">The length of the upload in bytes</param>
/// <param name="metadata">The Upload-Metadata request header or null if no header was provided</param>
/// <param name="cancellationToken">Cancellation token to use when cancelling</param>
/// <returns></returns>
Task<string> CreateFileAsync(long uploadLength, string metadata, CancellationToken cancellationToken); /// <summary>
/// Get the Upload-Metadata header as it was provided to <code>CreateFileAsync</code>.
/// </summary>
/// <param name="fileId">The id of the file to get the header for</param>
/// <param name="cancellationToken">Cancellation token to use when cancelling</param>
/// <returns>The Upload-Metadata header</returns>
Task<string> GetUploadMetadataAsync(string fileId, CancellationToken cancellationToken);
}

public interface ITusCreationDeferLengthStore
{
/// <summary>
/// Set the upload length (in bytes) of the provided file.
/// </summary>
/// <param name="fileId">The id of the file to set the upload length for</param>
/// <param name="uploadLength">The length of the upload in bytes</param>
/// <param name="cancellationToken">Cancellation token to use when cancelling</param>
/// <returns>Task</returns>
Task SetUploadLengthAsync(string fileId, long uploadLength, CancellationToken cancellationToken);
}

public interface ITusTerminationStore
{
/// <summary>
/// Delete a file from the data store.
/// </summary>
/// <param name="fileId">The id of the file to delete</param>
/// <param name="cancellationToken">Cancellation token to use when cancelling</param>
/// <returns>Task</returns>
Task DeleteFileAsync(string fileId, CancellationToken cancellationToken);
}

public interface ITusReadableStore
{
/// <summary>
/// Get the file with the specified id.
/// Returns null if the file was not found.
/// </summary>
/// <param name="fileId">The id of the file to get</param>
/// <param name="cancellationToken">Cancellation token to use when cancelling</param>
/// <returns>The file or null if the file was not found</returns>
Task<ITusFile> GetFileAsync(string fileId, CancellationToken cancellationToken);
}

public interface ITusExpirationStore
{
/// <summary>
/// Set the expiry date of the provided file.
/// This method will be called once during creation if absolute expiration is used.
/// This method will be called once per patch request if sliding expiration is used.
/// </summary>
/// <param name="fileId">The id of the file to update the expiry date for</param>
/// <param name="expires">The datetime offset when the file expires</param>
/// <param name="cancellationToken">Cancellation token to use when cancelling</param>
/// <returns>Task</returns>
Task SetExpirationAsync(string fileId, DateTimeOffset expires, CancellationToken cancellationToken); /// <summary>
/// Get the expiry date of the provided file (set by <code>SetExpirationAsync</code>).
/// If the datetime offset returned has passed an error will be returned to the client.
/// If no expiry date exist for the file, this method returns null.
/// </summary>
/// <param name="fileId">The id of the file to get the expiry date for</param>
/// <param name="cancellationToken">Cancellation token to use when cancelling</param>
/// <returns></returns>
Task<DateTimeOffset?> GetExpirationAsync(string fileId, CancellationToken cancellationToken); /// <summary>
/// Returns a list of ids of incomplete files that have expired.
/// This method can be used to do batch processing of incomplete, expired files before removing them.
/// </summary>
/// <param name="cancellationToken">Cancellation token to use when cancelling</param>
/// <returns>A list of ids of incomplete files that have expired</returns>
Task<IEnumerable<string>> GetExpiredFilesAsync(CancellationToken cancellationToken); /// <summary>
/// Remove all incomplete files that have expired.
/// </summary>
/// <param name="cancellationToken">Cancellation token to use when cancelling</param>
/// <returns>The number of files that were removed</returns>
Task<int> RemoveExpiredFilesAsync(CancellationToken cancellationToken);
}