module Xapian - RDoc Documentation

# module Xapian

# Ruby `Xapian` bindings¶ ↑

Original version by Paul Legato (plegato@nks.net), 4/20/06.

Copyright © 2006 Networked Knowledge Systems, Inc. Copyright © 2008,2011,2019 Olly Betts Copyright © 2010 Richard Boulton

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

## Underscore methods¶ ↑

Note: Methods whose names start with an underscore character _ are internal methods from the C++ API. Their functionality is not accessible in a Ruby-friendly way, so this file provides wrapper code to make it easier to use them from a Ruby programming idiom. Most are also dangerous insofar as misusing them can cause your program to segfault. In particular, all of Xapian’s *Iterator classes are wrapped into nice Ruby-friendly Arrays.

It should never be necessary to use any method whose name starts with an underscore from user-level code. Make sure you are VERY certain that you know exactly what you’re doing if you do use one of these methods. Beware. You’ve been warned…

### Public Class Methods

BAD_VALUENO() click to toggle source

Compatibility wrapping for `Xapian::BAD_VALUENO` (wrapped as a constant since xapian-bindings 1.4.10).

    # File xapian.rb, line 403
    def Xapian::BAD_VALUENO()
      return Xapian::BAD_VALUENO
    end