FileUtils.h

Go to the documentation of this file.

/* -*- c++ -*-
 * Copyright (C) 2007-2015 Hypertable, Inc.
 *
 * This file is part of Hypertable.
 *
 * Hypertable is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or any later version.
 *
 * Hypertable is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */

#ifndef Common_FileUtils_h
#define Common_FileUtils_h

#include <Common/String.h>

#include <mutex>
#include <vector>

extern "C" {
#include <dirent.h>
#include <sys/socket.h>
#include <sys/types.h>
}

namespace Hypertable {

  class FileUtils {
  public:
    static bool read(const String &fname, String &contents);

    static ssize_t read(int fd, void *vptr, size_t n);

    static ssize_t pread(int fd, void *vptr, size_t n, off_t offset);

    static ssize_t write(const String &fname, const std::string &contents);

    static ssize_t write(int fd, const void *vptr, size_t n);

    static ssize_t write(int fd, const std::string &str) {
      return write(fd, str.c_str(), str.length());
    }

    static ssize_t writev(int fd, const struct iovec *vector, int count);

    static ssize_t sendto(int fd, const void *vptr, size_t n,
                          const sockaddr *to, socklen_t tolen);

    static ssize_t send(int fd, const void *vptr, size_t n);

    static ssize_t recvfrom(int fd, void *vptr, size_t n,
            struct sockaddr *from, socklen_t *fromlen);

    static ssize_t recv(int fd, void *vptr, size_t n);

    static bool set_flags(int fd, int flags);

    static char *file_to_buffer(const String &fname, off_t *lenp);

    static String file_to_string(const String &fname);

    static void *mmap(const String &fname, off_t *lenp);

    static bool mkdirs(const String &dirname);

    static bool exists(const String &fname);

    static bool unlink(const String &fname);

    static bool rename(const String &oldpath, const String &newpath);

    static uint64_t size(const String &fname);

    static off_t length(const String &fname);

    static void add_trailing_slash(String &path);

    static bool expand_tilde(String &fname);

    static void readdir(const String &dirname, const String &fname_regex,
                        std::vector<struct dirent> &listing);

    static std::mutex ms_mutex;
  };

}

#endif // Common_FileUtils_h