file/lib/Driver.php

<?php

namespace Amp\File;

use AsyncInterop\Promise;

interface Driver {
    /**
     * Open a handle for the specified path
     *
     * @param string $path
     * @param string $mode
     * @return \AsyncInterop\Promise<\Amp\File\Handle>
     */
    public function open(string $path, string $mode): Promise;

    /**
     * Execute a file stat operation
     *
     * If the requested path does not exist the resulting Promise will resolve to NULL.
     *
     * @param string $path The file system path to stat
     * @return \AsyncInterop\Promise<array|null>
     */
    public function stat(string $path): Promise;

    /**
     * Does the specified path exist?
     *
     * This function should never resolve as a failure -- only a successfull bool value
     * indicating the existence of the specified path.
     *
     * @param string $path An absolute file system path
     * @return \AsyncInterop\Promise<bool>
     */
    public function exists(string $path): Promise;

    /**
     * Retrieve the size in bytes of the file at the specified path.
     *
     * If the path does not exist or is not a regular file this
     * function's returned Promise WILL resolve as a failure.
     *
     * @param string $path An absolute file system path
     * @return \AsyncInterop\Promise<int>
     */
    public function size(string $path): Promise;

    /**
     * Does the specified path exist and is it a directory?
     *
     * If the path does not exist the returned Promise will resolve
     * to FALSE and will not reject with an error.
     *
     * @param string $path An absolute file system path
     * @return \AsyncInterop\Promise<bool>
     */
    public function isdir(string $path): Promise;

    /**
     * Does the specified path exist and is it a file?
     *
     * If the path does not exist the returned Promise will resolve
     * to FALSE and will not reject with an error.
     *
     * @param string $path An absolute file system path
     * @return \AsyncInterop\Promise<bool>
     */
    public function isfile(string $path): Promise;

    /**
     * Retrieve the path's last modification time as a unix timestamp
     *
     * @param string $path An absolute file system path
     * @return \AsyncInterop\Promise<int>
     */
    public function mtime(string $path): Promise;

    /**
     * Retrieve the path's last access time as a unix timestamp
     *
     * @param string $path An absolute file system path
     * @return \AsyncInterop\Promise<int>
     */
    public function atime(string $path): Promise;

    /**
     * Retrieve the path's creation time as a unix timestamp
     *
     * @param string $path An absolute file system path
     * @return \AsyncInterop\Promise<int>
     */
    public function ctime(string $path): Promise;

    /**
     * Same as stat() except if the path is a link then the link's data is returned
     *
     * @param string $path The file system path to stat
     * @return \AsyncInterop\Promise A promise resolving to an associative array upon successful resolution
     */
    public function lstat(string $path): Promise;

    /**
     * Create a symlink $link pointing to the file/directory located at $target
     *
     * @param string $target
     * @param string $link
     * @return \AsyncInterop\Promise
     */
    public function symlink(string $target, string $link): Promise;

    /**
     * Create a hard link $link pointing to the file/directory located at $target
     *
     * @param string $target
     * @param string $link
     * @return \AsyncInterop\Promise
     */
    public function link(string $target, string $link): Promise;

    /**
     * Read the symlink at $path.
     *
     * @param string $target
     * @return \AsyncInterop\Promise
     */
    public function readlink(string $target): Promise;

    /**
     * Rename a file or directory
     *
     * @param string $from
     * @param string $to
     * @return \AsyncInterop\Promise
     */
    public function rename(string $from, string $to): Promise;

    /**
     * Delete a file
     *
     * @param string $path
     * @return \AsyncInterop\Promise
     */
    public function unlink(string $path): Promise;

    /**
     * Create a director
     *
     * @param string $path
     * @param int $mode
     * @param bool $recursive
     * @return \AsyncInterop\Promise
     */
    public function mkdir(string $path, int $mode = 0644, bool $recursive = false): Promise;

    /**
     * Delete a directory
     *
     * @param string $path
     * @return \AsyncInterop\Promise
     */
    public function rmdir(string $path): Promise;

    /**
     * Retrieve an array of files and directories inside the specified path
     *
     * Dot entries are not included in the resulting array (i.e. "." and "..").
     *
     * @param string $path
     * @return \AsyncInterop\Promise
     */
    public function scandir(string $path): Promise;

    /**
     * chmod a file or directory
     *
     * @param string $path
     * @param int $mode
     * @return \AsyncInterop\Promise
     */
    public function chmod(string $path, int $mode): Promise;

    /**
     * chown a file or directory
     *
     * @param string $path
     * @param int $uid
     * @param int $gid
     * @return \AsyncInterop\Promise
     */
    public function chown(string $path, int $uid, int $gid): Promise;

    /**
     * Update the access and modification time of the specified path
     *
     * If the file does not exist it will be created automatically.
     *
     * @param string $path
     * @return \AsyncInterop\Promise
     */
    public function touch(string $path): Promise;

    /**
     * Buffer the specified file's contents
     *
     * @param string $path The file path from which to buffer contents
     * @return \AsyncInterop\Promise A promise resolving to a string upon successful resolution
     */
    public function get(string $path): Promise;

    /**
     * Write the contents string to the specified path.
     *
     * @param string $path The file path to which to $contents should be written
     * @param string $contents The data to write to the specified $path
     * @return \AsyncInterop\Promise A promise resolving to the integer length written upon success
     */
    public function put(string $path, string $contents): Promise;
}