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

Lucy::Plan::BlobType

parcel Lucy
class variable LUCY_BLOBTYPE
struct symbol lucy_BlobType
class nickname lucy_BlobType
header file Lucy/Plan/BlobType.h

Name

Lucy::Plan::BlobType – Default behaviors for binary fields.

Description

BlobType is an implementation of FieldType tuned for use with fields containing binary data, which cannot be indexed or searched – only stored.

Functions

new
lucy_BlobType* // incremented
lucy_BlobType_new(
    bool stored
);

Create a new BlobType.

stored

boolean indicating whether the field should be stored.

init
lucy_BlobType*
lucy_BlobType_init(
    lucy_BlobType *self,
    bool stored
);

Initialize a BlobType.

stored

boolean indicating whether the field should be stored.

Methods

Binary
bool
lucy_BlobType_Binary(
    lucy_BlobType *self
);

Returns true.

Set_Sortable
void
lucy_BlobType_Set_Sortable(
    lucy_BlobType *self,
    bool sortable
);

Throws an error unless sortable is false.

Equals
bool
lucy_BlobType_Equals(
    lucy_BlobType *self,
    cfish_Obj *other
);

Compares all common properties.

Methods inherited from Lucy::Plan::FieldType

Set_Boost
void
lucy_BlobType_Set_Boost(
    lucy_BlobType *self,
    float boost
);

Setter for boost.

Get_Boost
float
lucy_BlobType_Get_Boost(
    lucy_BlobType *self
);

Accessor for boost.

Set_Indexed
void
lucy_BlobType_Set_Indexed(
    lucy_BlobType *self,
    bool indexed
);

Setter for indexed.

Indexed
bool
lucy_BlobType_Indexed(
    lucy_BlobType *self
);

Accessor for indexed.

Set_Stored
void
lucy_BlobType_Set_Stored(
    lucy_BlobType *self,
    bool stored
);

Setter for stored.

Stored
bool
lucy_BlobType_Stored(
    lucy_BlobType *self
);

Accessor for stored.

Sortable
bool
lucy_BlobType_Sortable(
    lucy_BlobType *self
);

Accessor for sortable.

Inheritance

Lucy::Plan::BlobType is a Lucy::Plan::FieldType is a Clownfish::Obj.