bpf::io::File class
#include <Base/include/Framework/IO/File.hpp>

Contents

Cross platform file utilities

Constructors, destructors, conversion operators

File(const String& path) explicit
File()

Public functions

auto HasAccess(fint type) const -> bool
auto Exists() const -> bool
auto IsHidden() const -> bool
auto IsDirectory() const -> bool
auto GetSizeBytes() const -> uint64
auto Delete() -> bool
auto Hide(bool flag) -> bool
auto ListFiles() const -> collection::List<File>
auto CreateDir() -> bool
auto CopyTo(const File& dst, bool overwrite = false) -> bool
auto MoveTo(const File& dst) -> bool
auto Path() const -> const String&
auto PlatformPath() const -> const String&
auto operator+(const File& other) const -> File
auto operator+(const String& other) const -> File
auto GetParent() const -> File
auto GetAbsolutePath() const -> File
auto Name() const -> const String&
auto Extension() const -> const String&
auto operator==(const File& other) const -> bool
auto operator!=(const File& other) const -> bool

Function documentation

bpf::io::File::File(const String& path) explicit

Parameters
path the path string (use '/' as path separator on any platform)

Constructs a File from a path

bpf::io::File::File()

Constructs a File

bool bpf::io::File::HasAccess(fint type) const

Parameters
type the access type to check (see FILE_MODE_* constants)
Returns true if the access is granted, false otherwise

Checks wether the current application is allowed to access a given file or folder

bool bpf::io::File::Exists() const

Returns true if the file exists, false otherwise

Checks if the file exists

bool bpf::io::File::IsHidden() const

Returns true if the file is hidden, false otherwise

Checks if the file is a hidden file

bool bpf::io::File::IsDirectory() const

Returns true if the file is a directory (or folder on Windows), false otherwise

Checks if the file is a directory (or folder on Windows)

uint64 bpf::io::File::GetSizeBytes() const

Returns size in bytes as unsigned
Exceptions
IOException in case of system error

Returns the size in bytes of that file

bool bpf::io::File::Delete()

Returns true if the operation succeeded, false otherwise

Deletes this file from the file system

bool bpf::io::File::Hide(bool flag)

Parameters
flag true to hide the file, false to make the file visible
Returns true if the operation succeeded, false otherwise

Marks this file as hidden to the current platform

collection::List<File> bpf::io::File::ListFiles() const

Returns the output list of files (including directories/folders)
Exceptions
IOException in case of system error

Lists all files in that directory/folder (of course if this file is a directory/folder)

bool bpf::io::File::CreateDir()

Returns true if the operation succeeded, false otherwise

Creates the directory/folder

bool bpf::io::File::CopyTo(const File& dst, bool overwrite = false)

Parameters
dst the destination file or directory/folder
overwrite true to overwrite any existing file, false otherwise
Returns true if operation succeeded, false otherwise

Copies this file to the destination, in case destination is a directory/folder, copy in that directory/folder under the same name

bool bpf::io::File::MoveTo(const File& dst)

Parameters
dst the destination file or directory/folder
Returns true if operation succeeded, false otherwise

Moves this file to the destination, in case destination is a directory/folder, move in that directory/folder under the same name

const String& bpf::io::File::Path() const

Returns immutable high-level string

Returns the full path to the file (as given in the constructor)

const String& bpf::io::File::PlatformPath() const

Returns immutable high-level string

Returns the path as expected by platform conventions

File bpf::io::File::operator+(const File& other) const

Parameters
other the file to append (a path separator is automatically added)
Returns new File from concatenation

Concatenates this file to another

File bpf::io::File::operator+(const String& other) const

Parameters
other the file to append (a path separator is automatically added)
Returns new File from concatenation

Concatenates this file to another

File bpf::io::File::GetParent() const

Returns empty File if no parent, other parent directory/folder

Get parent directory/folder if any

File bpf::io::File::GetAbsolutePath() const

Returns new File
Exceptions
IOException in case of system error

Returns the absolute path constructed from this path, That means a path that starts from system's root (usually '/...' on linux and 'C:\' on Windows)

const String& bpf::io::File::Name() const

Returns immutable high-level string

Returns the file's name

const String& bpf::io::File::Extension() const

Returns immutable high-level string

Returns the file's extension

bool bpf::io::File::operator==(const File& other) const

Parameters
other operand
Returns true if this equals other, false otherwise

Compare File

bool bpf::io::File::operator!=(const File& other) const

Parameters
other operand
Returns true if this does not equal other, false otherwise

Compare File