Project Lucy has retired. For details please refer to its Attic page.
Lucy::Store::FSFolder – C API Documentation
Apache Lucy™

Lucy::Store::FSFolder

parcel Lucy
class variable LUCY_FSFOLDER
struct symbol lucy_FSFolder
class nickname lucy_FSFolder
header file Lucy/Store/FSFolder.h

Name

Lucy::Store::FSFolder – File System implementation of Folder.

Description

Implementation of Folder using a single file system directory and multiple files.

Functions

new
lucy_FSFolder* // incremented
lucy_FSFolder_new(
    cfish_String *path
);

Create a new Folder.

path

Location of the index. If the specified directory does not exist already, it will NOT be created, in order to prevent misconfigured read applications from spawning bogus files – so it may be necessary to create the directory yourself.

init
lucy_FSFolder*
lucy_FSFolder_init(
    lucy_FSFolder *self,
    cfish_String *path
);

Initialize a Folder. See new() for a description of the parameters.

Inheritance

Lucy::Store::FSFolder is a Lucy::Store::Folder is a Clownfish::Obj.