Files
inkblot/InkBlot/IFileReader.cs
2025-02-16 18:26:28 +01:00

17 lines
531 B
C#

namespace InkBlot;
/// <summary>
/// An object that can read files.
/// </summary>
public interface IFileReader
{
/// <summary>
/// Get the contents of a file.
/// </summary>
/// <param name="filename">
/// Name of the file to read. The name is relative to the main ink file. The name is normalized
/// (uses only single forward slashes between path elements).
/// </param>
/// <returns>A stream with the contents of the file.</returns>
Stream GetContents(string filename);
}