File.h

// Copyright (c) Stefano Cristiano
// SPDX-License-Identifier: MIT
#pragma once
#include "../Strings/StringView.h"
#include "FileDescriptor.h"
 
namespace SC
{
struct Buffer;
struct String;
} // namespace SC
 
struct SC::File
{
    FileDescriptor& fd;
 
    File(FileDescriptor& descriptor) : fd(descriptor) {}
 
    enum OpenMode
    {
        ReadOnly,            
        WriteCreateTruncate, 
        WriteAppend,         
        ReadAndWrite         
    };
 
    struct OpenOptions
    {
        bool inheritable = false; 
        bool blocking    = true;  
    };
 
    [[nodiscard]] Result open(StringView path, OpenMode mode);
 
    [[nodiscard]] Result open(StringView path, OpenMode mode, OpenOptions options);
 
    [[nodiscard]] Result readUntilEOF(Buffer& destination);
 
    [[nodiscard]] Result readUntilEOF(String& destination);
 
  private:
    struct Internal;
    struct ReadResult;
    Result readUntilEOFTemplate(Buffer& destination);
};