Public Member Functions | List of all members
FileByteWriteResource Class Reference

A write only standard file on a file system which is written as bytes. More...

#include <FileByteWriteResource.hpp>

Inheritance diagram for FileByteWriteResource:
[legend]
Collaboration diagram for FileByteWriteResource:
[legend]

Public Member Functions

 FileByteWriteResource (const File &file_)
 Create a new file byte write resource from the supplied file URI. More...
 
void close () override
 Close the stream(s) in the resource. More...
 
const File & getFile () const
 Get the file URI. More...
 
const Uri & uri () const override
 Get the URI associated with this resource. More...
 
std::ostream & writeStream () override
 Get the output stream of the byte write resource. More...
 
- Public Member Functions inherited from Resource
virtual ~Resource ()=default
 Destroy the resource instance. More...
 

Detailed Description

A write only standard file on a file system which is written as bytes.

Constructor & Destructor Documentation

◆ FileByteWriteResource()

FileByteWriteResource ( const File &  file_)
explicit

Create a new file byte write resource from the supplied file URI.

Member Function Documentation

◆ close()

void close ( )
inlineoverridevirtual

Close the stream(s) in the resource.

Implements Resource.

◆ getFile()

const File& getFile ( ) const

Get the file URI.

Returns
the file URI

◆ uri()

const Uri& uri ( ) const
overridevirtual

Get the URI associated with this resource.

Implements Resource.

◆ writeStream()

std::ostream& writeStream ( )
inlineoverridevirtual

Get the output stream of the byte write resource.

Implements ByteWriteResource.


The documentation for this class was generated from the following file: