Metadata-Version: 1.1
Name: fallocate
Version: 1.6.3
Summary: Module to expose posix_fallocate(3), posix_fadvise(3) and fallocate(2)
Home-page: https://github.com/trbs/fallocate
Author: I.S. van Oostveen
Author-email: trbs@trbs.net
License: Python Software Foundation License
Description: =========
        fallocate
        =========
        
        .. image:: https://travis-ci.org/trbs/fallocate.svg?branch=master
            :target: https://travis-ci.org/trbs/fallocate
        
        fallocate exposes an interface to fallocate(2), posix_fallocate(3) and
        posix_fadvise(3).
        
        Under Mac OS X the fallocate() method will use the apple equivalent of
        fallocate(2). Note that this might not be exactly the same.
        
        When using the wrapper functions around the fallocate(2) call the arguments
        given to the function are slightly different then the c call.
        
        This module has the arguments like:
        
        ::
        
          fallocate(fd, offset, length, mode=0)
        
        While in C the function looks like:
        
        ::
        
          fallocate(fd, mode, offset, length)
        
        The main reason for this is that the mode argument tends not to be used much and
        thus having the default as a keyword argument is much easier then having to
        specify 0 everytime.
        
        Usage
        =====
        
        Funcation: fallocate(fd, offset, len, [mode=0])
        
        Calls fallocate() on the file object or file descriptor. This allows
        the caller to directly manipulate the allocated disk space for the file
        referred to by fd for the byte range starting at offset and continuing
        for len bytes.
        
        mode is only available in Linux.
        
        It should always be 0 unless one of the two following possible flags are
        specified
        
        ::
        
            FALLOC_FL_KEEP_SIZE  - do not grow file, default is extend size
            FALLOC_FL_PUNCH_HOLE - punches a hole in file, de-allocates range
        
        Example:
        
        ::
        
            # preallocate using fallocate a 1kb file
            with open("/tmp/test.file", "w+b") as f:
                fallocate(f, 0, 1024)
        
Keywords: posix_fallocate posix_fadvise fallocate
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Intended Audience :: Developers
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Classifier: License :: OSI Approved :: Python Software Foundation License
