roo_io
API Documentation for roo_io
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions
roo_io::Filesystem Class Referenceabstract

#include <filesystem.h>

Public Types

enum  MediaPresence { kMediaAbsent = 0 , kMediaPresent = 1 , kMediaPresenceUnknown = 2 }
 
enum  MountingPolicy { kMountReadWrite , kMountReadOnly , kMountDisabled }
 
enum  UnmountingPolicy { kUnmountLazily = 0 , kUnmountEagerly = 1 }
 

Public Member Functions

virtual ~Filesystem ()=default
 
Mount mount ()
 
bool isMounted () const
 
bool isInUse () const
 
virtual MediaPresence checkMediaPresence ()=0
 
MountingPolicy mountingPolicy () const
 
void setMountingPolicy (MountingPolicy mounting_policy)
 
UnmountingPolicy unmountingPolicy () const
 
void setUnmountingPolicy (UnmountingPolicy unmounting_policy)
 
void forceUnmount ()
 

Protected Member Functions

 Filesystem ()
 
virtual MountImpl::MountResult mountImpl (std::function< void()> unmount_fn)=0
 
virtual void unmountImpl ()=0
 

Detailed Description

Definition at line 14 of file filesystem.h.

Member Enumeration Documentation

◆ MediaPresence

enum roo_io::Filesystem::MediaPresence
Enumerator
kMediaAbsent 
kMediaPresent 
kMediaPresenceUnknown 

Definition at line 19 of file filesystem.h.

◆ MountingPolicy

enum roo_io::Filesystem::MountingPolicy
Enumerator
kMountReadWrite 
kMountReadOnly 
kMountDisabled 

Definition at line 32 of file filesystem.h.

◆ UnmountingPolicy

enum roo_io::Filesystem::UnmountingPolicy
Enumerator
kUnmountLazily 
kUnmountEagerly 

Definition at line 45 of file filesystem.h.

Constructor & Destructor Documentation

◆ ~Filesystem()

virtual roo_io::Filesystem::~Filesystem ( )
virtualdefault

◆ Filesystem()

roo_io::Filesystem::Filesystem ( )
inlineprotected

Definition at line 116 of file filesystem.h.

Member Function Documentation

◆ checkMediaPresence()

virtual MediaPresence roo_io::Filesystem::checkMediaPresence ( )
pure virtual

Referenced by mount().

◆ forceUnmount()

void roo_io::Filesystem::forceUnmount ( )

Definition at line 44 of file filesystem.cpp.

References unmountImpl().

◆ isInUse()

bool roo_io::Filesystem::isInUse ( ) const
inline

Definition at line 76 of file filesystem.h.

References kUnmountEagerly.

◆ isMounted()

bool roo_io::Filesystem::isMounted ( ) const
inline

Definition at line 70 of file filesystem.h.

◆ mount()

Mount roo_io::Filesystem::mount ( )

Definition at line 5 of file filesystem.cpp.

References checkMediaPresence(), roo_io::kGenericMountError, kMediaAbsent, kMountDisabled, kMountReadOnly, roo_io::kNoMedia, roo_io::kNotMounted, roo_io::kOk, kUnmountLazily, mountImpl(), mountingPolicy(), roo_io::MountImpl::MountResult::status, and unmountImpl().

Referenced by roo_io::FileResource::open().

◆ mountImpl()

virtual MountImpl::MountResult roo_io::Filesystem::mountImpl ( std::function< void()>  unmount_fn)
protectedpure virtual

Referenced by mount().

◆ mountingPolicy()

MountingPolicy roo_io::Filesystem::mountingPolicy ( ) const
inline

Definition at line 87 of file filesystem.h.

Referenced by mount().

◆ setMountingPolicy()

void roo_io::Filesystem::setMountingPolicy ( MountingPolicy  mounting_policy)
inline

Definition at line 91 of file filesystem.h.

◆ setUnmountingPolicy()

void roo_io::Filesystem::setUnmountingPolicy ( UnmountingPolicy  unmounting_policy)

Definition at line 35 of file filesystem.cpp.

References kUnmountEagerly.

◆ unmountImpl()

virtual void roo_io::Filesystem::unmountImpl ( )
protectedpure virtual

Referenced by forceUnmount(), and mount().

◆ unmountingPolicy()

UnmountingPolicy roo_io::Filesystem::unmountingPolicy ( ) const
inline

Definition at line 96 of file filesystem.h.

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