cSVFS.cpp File Reference

#include "cpp_svfs.h"
#include "_cSVF.cpp"
#include "_cSVFS.cpp"

Go to the source code of this file.

Functions
PyMODINIT_FUNC	PyInit_svfsc (void)

Variables
static PyModuleDef	svfsmodule

Detailed Description

A Sparse Virtual File implementation.

   MIT License

   Copyright (c) 2020-2024 Paul Ross

   Permission is hereby granted, free of charge, to any person obtaining a copy
   of this software and associated documentation files (the "Software"), to deal
   in the Software without restriction, including without limitation the rights
   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   copies of the Software, and to permit persons to whom the Software is
   furnished to do so, subject to the following conditions:

   The above copyright notice and this permission notice shall be included in all
   copies or substantial portions of the Software.

   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
   SOFTWARE.

Definition in file cSVFS.cpp.

Function Documentation

PyInit_svfsc()

PyMODINIT_FUNC PyInit_svfsc

(

void

)

Definition at line 58 of file cSVFS.cpp.

Variable Documentation

svfsmodule

PyModuleDef svfsmodule

static

Initial value:

= {
        PyModuleDef_HEAD_INIT,
        .m_name = "svfsc",
        .m_doc = 
        "This module contains Sparse Virtual File System classes."
        "\n"
        "A Sparse Virtual File (SVF) is one where data from the actual file is held in memory at the relevant"
        " file locations as in the original file."
        " The original file is identified by a string ID."
        " Data can be written to an SVF, if the data differs from that existing an error might be raised."
        " Data can be read from an SVF, if the SVF does not have the data an error will be raised."
        " Before any ``read()`` the SVF can describe what, if any, data is missing and the user can obtain and write that"
        " data to the SVF before reading."
        "\n\n"
        "A Sparse Virtual File System (SVFS) is an extension of that concept where a file ID (string) is the key to the"
        " appropriate SVF.",
        .m_size = -1,
}

Definition at line 38 of file cSVFS.cpp.