############
AbstractFile
############

.. cpp:namespace:: SC::IO::AbstractFile

.. default-domain:: cpp

Content
=======

====== =============
class  File         
class  File_Manager 
====== =============

Types
=====

=== ==================================================
..  :cpp:enumerator:`~SC::IO::AbstractFile::State`    
..  :cpp:enumerator:`~SC::IO::AbstractFile::Position` 
=== ==================================================

Fields
======

=== =============================================
..  :cpp:enum:`~SC::IO::AbstractFile::None`      
..  :cpp:enum:`~SC::IO::AbstractFile::Again`     
..  :cpp:enum:`~SC::IO::AbstractFile::Failed`    
..  :cpp:enum:`~SC::IO::AbstractFile::ReadOnly`  
..  :cpp:enum:`~SC::IO::AbstractFile::ReadWrite` 
..  :cpp:enum:`~SC::IO::AbstractFile::Begin`     
..  :cpp:enum:`~SC::IO::AbstractFile::Current`   
..  :cpp:enum:`~SC::IO::AbstractFile::End`       
=== =============================================

Functions
=========

=============================================== ===================================================================================================================
..                                              :cpp:func:`~AbstractFile <virtual SC::IO::AbstractFile::~AbstractFile>`                                            
..                                              :cpp:func:`AbstractFile <SC::IO::AbstractFile::AbstractFile>`                                                      
..                                              :cpp:func:`AbstractFile <SC::IO::AbstractFile::AbstractFile>`                                                      
void                                            :cpp:func:`SetPath <void SC::IO::AbstractFile::SetPath(path const &path)>`                                         
:doc:`classSC_1_1IO_1_1path` const &            :cpp:func:`GetPath <path const  & SC::IO::AbstractFile::GetPath() const>`                                          
:cpp:enumerator:`~SC::IO::AbstractFile::State`  :cpp:func:`GetState <State SC::IO::AbstractFile::GetState() const>`                                                
bool                                            :cpp:func:`IsOpen <bool SC::IO::AbstractFile::IsOpen() const>`                                                     
void                                            :cpp:func:`Release <void SC::IO::AbstractFile::Release()>`                                                         
:cpp:enumerator:`~SC::IO::AbstractFile::State`  :cpp:func:`AcquireReadOnly <State SC::IO::AbstractFile::AcquireReadOnly(bool create_if_missing)>`                  
:cpp:enumerator:`~SC::IO::AbstractFile::State`  :cpp:func:`AcquireReadWrite <State SC::IO::AbstractFile::AcquireReadWrite(bool create_if_missing, bool truncate)>` 
int64_t                                         :cpp:func:`Seek <int64_t SC::IO::AbstractFile::Seek(int64_t offset, Position position=Position::Begin)>`           
bool                                            :cpp:func:`Truncate <bool SC::IO::AbstractFile::Truncate()>`                                                       
int64_t                                         :cpp:func:`Size <int64_t SC::IO::AbstractFile::Size() const>`                                                      
size_t                                          :cpp:func:`Read <size_t SC::IO::AbstractFile::Read(void *data, size_t n_bytes)>`                                   
size_t                                          :cpp:func:`Write <size_t SC::IO::AbstractFile::Write(void const *data, size_t n_bytes)>`                           
bool                                            :cpp:func:`Flush <bool SC::IO::AbstractFile::Flush()>`                                                             
=============================================== ===================================================================================================================

.. cpp:namespace:: nullptr

Detailed Description
====================

.. doxygenclass:: SC::IO::AbstractFile
   :project: libsc
   :members:
   :undoc-members:



