utl::File Class Reference
#include <File.h>
Inheritance diagram for utl::File:
Public Member Functions | |
| File (const String &path, const Directory *dir=nullptr) | |
| Constructor. More... | |
| void | make (uint_t mode=uint_t_max) const |
| Create a file with the given mode. More... | |
 Public Member Functions inherited from utl::FSobject | |
| FSobject (const String &path, const Directory *dir=nullptr) | |
| Constructor. More... | |
| virtual int | compare (const Object &rhs) const |
| Compare with another object. More... | |
| virtual void | copy (const Object &rhs) |
| Copy another instance. More... | |
| virtual void | dump (Stream &os, uint_t level=uint_t_max) const |
| Dump a human-readable representation of self to the given output stream. More... | |
| virtual const Object & | getKey () const |
| Get the key for this object. More... | |
| virtual void | serialize (Stream &stream, uint_t io, uint_t mode=ser_default) |
| Serialize to or from a stream. More... | |
| virtual String | toString () const |
| Return a string representation of self. More... | |
| Pathname | path () const |
| Get the path. More... | |
| void | setPath (const String &path, const Directory *dir=nullptr) |
| Set the path. More... | |
| Pathname | relativePath () const |
| Get the relative path. More... | |
| const Directory * | directory () const |
| Get the parent directory. More... | |
| void | setDirectory (const Directory *dir) |
| Set the parent directory. More... | |
| bool | exists (bool ignoreEx=false) const |
| Determine whether the object exists in the filesystem. More... | |
| void | rename (const String &path, bool relative=true) |
| Rename the object. More... | |
| virtual void | unlink () |
| Remove the object from the filesystem. More... | |
| bool | isMarked () const |
| Get the marked flag. More... | |
| void | setMarked (bool marked) |
| Set the marked flag. More... | |
| void | clearStat () |
| Clear stat information. | |
| void | takeStat (FSobject &rhs) |
| Take stat information from another instance. More... | |
| void | stat (bool force=false) const |
| Obtain stat information. | |
| void | lstat (bool force=false) const |
| Obtain stat information (don't dereference a symlink). More... | |
| uint32_t | device () const |
| Get the device type. More... | |
| uint32_t | inode () const |
| Get the inode. More... | |
| uint32_t | mode () const |
| Get the access mode. More... | |
| void | setMode (uint32_t mode) |
| Set the access mode. More... | |
| uint32_t | numLinks () const |
| Get the number of hard links. More... | |
| uint32_t | userId () const |
| Get the user id. More... | |
| uint32_t | groupId () const |
| Get the group id. More... | |
| uint32_t | deviceType () const |
| Get the device type. More... | |
| size_t | size () const |
| Get the size. More... | |
| ulong_t | blockSize () const |
| Get the preferred block size for I/O. More... | |
| ulong_t | numBlocks () const |
| Get the number of blocks allocated. More... | |
| Time | accessTime () const |
| Get the time of last access. More... | |
| Time | modifyTime () const |
| Get the time of last modification (writing). More... | |
| Time | changeTime () const |
| Get the time of last change (writing or changing inode information). More... | |
| Public Member Functions inherited from utl::Object | |
| void | clear () |
| Revert to initial state. More... | |
| virtual void | vclone (const Object &rhs) |
| Make an exact copy of another instance. More... | |
| virtual void | steal (Object &rhs) |
| "Steal" the internal representation from another instance. More... | |
| void | dumpWithClassName (Stream &os, uint_t indent=4, uint_t level=uint_t_max) const |
| Front-end for dump() that prints the object's class name. More... | |
| bool | hasKey () const |
| Determine whether or not the object has a key. More... | |
| virtual const Object & | getProxiedObject () const |
| Get the proxied object (= self if none). More... | |
| virtual Object & | getProxiedObject () |
| Get the proxied object (= self if none). More... | |
| virtual size_t | hash (size_t size) const |
| Get the hash code for the object. More... | |
| bool | _isA (const RunTimeClass *runTimeClass) const |
| Determine whether self's class is a descendent of the given class. More... | |
| operator String () const | |
| Conversion to String. More... | |
| size_t | allocatedSize () const |
| Get the total allocated size of this object. More... | |
| virtual size_t | innerAllocatedSize () const |
| Get the "inner" allocated size. More... | |
| virtual void | addOwnedIt (const class FwdIt *it) const |
| Notify self that it owns the given iterator. More... | |
| virtual void | removeOwnedIt (const class FwdIt *it) const |
| Notify self that the given owned iterator has been destroyed. More... | |
| bool | operator< (const Object &rhs) const |
| Less-than operator. More... | |
| bool | operator<= (const Object &rhs) const |
| Less-than-or-equal-to operator. More... | |
| bool | operator> (const Object &rhs) const |
| Greater-than operator. More... | |
| bool | operator>= (const Object &rhs) const |
| Greater-than-or-equal-to operator. More... | |
| bool | operator== (const Object &rhs) const |
| Equal-to operator. More... | |
| bool | operator!= (const Object &rhs) const |
| Unequal-to operator. More... | |
| void | serializeIn (Stream &is, uint_t mode=ser_default) |
| Serialize from an input stream. More... | |
| void | serializeOut (Stream &os, uint_t mode=ser_default) const |
| Serialize to an output stream. More... | |
| void | serializeOutBoxed (Stream &os, uint_t mode=ser_default) const |
| Serialize a boxed object to an output stream. More... | |
Additional Inherited Members | |
| Public Types inherited from utl::FSobject | |
| enum | field_t { field_path , field_filename, field_basename, field_suffix, field_userId, field_groupId, field_size, field_mode, field_accessTime, field_modifyTime, field_changeTime } |
| Filesystem object attributes. More... | |
| Static Public Member Functions inherited from utl::FSobject | |
| static FSobject * | create (const String &path, const Directory *dir=nullptr, bool followLink=false) |
| Create an instance of the appropriate FSobject-derived class for the filesystem object at the given path. More... | |
| Static Public Member Functions inherited from utl::Object | |
| static Object * | serializeInNullable (Stream &is, uint_t mode=ser_default) |
| Serialize a nullptr-able object from an input stream. More... | |
| static void | serializeOutNullable (const Object *object, Stream &os, uint_t mode=ser_default) |
| Serialize a nullptr-able object to an output stream. More... | |
| static void | serializeNullable (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default) |
| Serialize a nullptr-able object to or from a stream. More... | |
| static Object * | serializeInBoxed (Stream &is, uint_t mode=ser_default) |
| Serialize a boxed object from an input stream. More... | |
| static void | serializeBoxed (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default) |
| Serialize a boxed object to or from a stream. More... | |
| Protected Member Functions inherited from utl::FlagsMI | |
| FlagsMI () | |
| Constructor. More... | |
| virtual | ~FlagsMI () |
| Destructor. More... | |
| void | copyFlags (const FlagsMI &rhs) |
| Copy the given flags. More... | |
| void | copyFlags (const FlagsMI &rhs, uint_t lsb, uint_t msb) |
| Copy (some of) the given flags. More... | |
| void | copyFlags (uint64_t flags, uint_t lsb, uint_t msb) |
| Copy (some of) the given flags. More... | |
| bool | getFlag (uint_t flagNum) const |
| Get a user-defined flag. More... | |
| void | setFlag (uint_t flagNum, bool val) |
| Set a user-defined flag. More... | |
| uint64_t | getFlagsNumber (uint64_t mask, uint64_t shift=0) |
| Get a multi-bit value in the flags data (which is stored as one 64-bit integer). More... | |
| void | setFlagsNumber (uint64_t mask, uint64_t shift, uint64_t num) |
| Set a multi-bit value in the flags data (which is stored as one 64-bit integer). More... | |
| uint64_t | getFlags () const |
| Get the flags. More... | |
| void | setFlags (uint64_t flags) |
| Set the flags. More... | |
Detailed Description
Constructor & Destructor Documentation
◆ File()
Constructor.
- Parameters
-
path file path dir (optional) parent directory
Definition at line 33 of file File.h.
References utl::uint_t_max.
Member Function Documentation
◆ make()
| void utl::File::make | ( | uint_t | mode = uint_t_max | ) | const |
Create a file with the given mode.
The documentation for this class was generated from the following file:
