### Home Classes Methods

### In Files

- lib/ferret/field_symbol.rb
- lib/ferret/index.rb
- lib/ferret/version.rb
- lib/ferret/document.rb
- ext/r_analysis.c
- ext/r_index.c
- ext/r_qparser.c
- ext/r_search.c
- ext/r_store.c
- ext/r_utils.c
- ext/ferret.c

### Namespace

- MODULE Ferret::Analysis
- MODULE Ferret::BoostMixin
- MODULE Ferret::Browser
- MODULE Ferret::FieldSymbolMethods
- MODULE Ferret::Index
- MODULE Ferret::Search
- MODULE Ferret::Store
- MODULE Ferret::Utils
- CLASS Ferret::BlankSlate
- CLASS Ferret::Document
- CLASS Ferret::Field
- CLASS Ferret::FieldSymbol
- CLASS Ferret::FileNotFoundError
- CLASS Ferret::ParseError
- CLASS Ferret::QueryParser
- CLASS Ferret::StateError

### Methods

- ::locale
- ::locale=

### Files

- MIT-LICENSE
- README
- TODO
- TUTORIAL

### Class/Module Index

Quicksearch

- Ferret
- Ferret::Analysis
- Ferret::Analysis::Analyzer
- Ferret::Analysis::AsciiLetterAnalyzer
- Ferret::Analysis::AsciiLetterTokenizer
- Ferret::Analysis::AsciiLowerCaseFilter
- Ferret::Analysis::AsciiStandardAnalyzer
- Ferret::Analysis::AsciiStandardTokenizer
- Ferret::Analysis::AsciiWhiteSpaceAnalyzer
- Ferret::Analysis::AsciiWhiteSpaceTokenizer
- Ferret::Analysis::HyphenFilter
- Ferret::Analysis::LetterAnalyzer
- Ferret::Analysis::LetterTokenizer
- Ferret::Analysis::LowerCaseFilter
- Ferret::Analysis::MappingFilter
- Ferret::Analysis::PerFieldAnalyzer
- Ferret::Analysis::RegExpAnalyzer
- Ferret::Analysis::RegExpTokenizer
- Ferret::Analysis::StandardAnalyzer
- Ferret::Analysis::StandardTokenizer
- Ferret::Analysis::StemFilter
- Ferret::Analysis::StopFilter
- Ferret::Analysis::Token
- Ferret::Analysis::TokenStream
- Ferret::Analysis::WhiteSpaceAnalyzer
- Ferret::Analysis::WhiteSpaceTokenizer
- Ferret::BlankSlate
- Ferret::BoostMixin
- Ferret::Browser
- Ferret::Browser::Controller
- Ferret::Browser::Delegator
- Ferret::Browser::DocumentController
- Ferret::Browser::ErrorController
- Ferret::Browser::HelpController
- Ferret::Browser::HomeController
- Ferret::Browser::TermController
- Ferret::Browser::TermVectorController
- Ferret::Browser::ViewHelper
- Ferret::Document
- Ferret::Field
- Ferret::FieldSymbol
- Ferret::FieldSymbolMethods
- Ferret::FileNotFoundError
- Ferret::Index
- Ferret::Index::FieldInfo
- Ferret::Index::FieldInfos
- Ferret::Index::Index
- Ferret::Index::IndexReader
- Ferret::Index::IndexWriter
- Ferret::Index::LazyDoc
- Ferret::Index::LazyDoc::LazyDocData
- Ferret::Index::TermDocEnum
- Ferret::Index::TermEnum
- Ferret::Index::TermVector
- Ferret::Index::TermVector::TVOffsets
- Ferret::Index::TermVector::TVTerm
- Ferret::ParseError
- Ferret::QueryParser
- Ferret::QueryParser::QueryParseException
- Ferret::Search
- Ferret::Search::BooleanQuery
- Ferret::Search::BooleanQuery::BooleanClause
- Ferret::Search::ConstantScoreQuery
- Ferret::Search::Explanation
- Ferret::Search::Filter
- Ferret::Search::FilteredQuery
- Ferret::Search::FuzzyQuery
- Ferret::Search::Hit
- Ferret::Search::MatchAllQuery
- Ferret::Search::MultiSearcher
- Ferret::Search::MultiTermQuery
- Ferret::Search::PhraseQuery
- Ferret::Search::PrefixQuery
- Ferret::Search::Query
- Ferret::Search::QueryFilter
- Ferret::Search::RangeFilter
- Ferret::Search::RangeQuery
- Ferret::Search::Searcher
- Ferret::Search::Sort
- Ferret::Search::SortField
- Ferret::Search::Spans
- Ferret::Search::Spans::SpanFirstQuery
- Ferret::Search::Spans::SpanMultiTermQuery
- Ferret::Search::Spans::SpanNearQuery
- Ferret::Search::Spans::SpanNotQuery
- Ferret::Search::Spans::SpanOrQuery
- Ferret::Search::Spans::SpanPrefixQuery
- Ferret::Search::Spans::SpanTermQuery
- Ferret::Search::TermQuery
- Ferret::Search::TopDocs
- Ferret::Search::TypedRangeFilter
- Ferret::Search::TypedRangeQuery
- Ferret::Search::WildcardQuery
- Ferret::StateError
- Ferret::Store
- Ferret::Store::Directory
- Ferret::Store::FSDirectory
- Ferret::Store::Lock
- Ferret::Store::Lock::LockError
- Ferret::Store::RAMDirectory
- Ferret::Utils
- Ferret::Utils::BitVector
- Ferret::Utils::MultiMapper
- Ferret::Utils::PriorityQueue
- WEBrick
- WEBrick::FerretBrowserHandler
- Date
- DateTime
- FileUtils
- Float
- Integer
- String
- Symbol
- Time

No matching classes.

# Ferret

BitVector

See the README

### Constants

EXCEPTION_MAP
FIELD_TYPES
FIX_INT_MAX
I
OBJECT_SPACE
VERSION

### Public Class Methods

locale → locale_str click to toggle source

Returns a string corresponding to the locale set. For example;

    puts Ferret.locale #=> "en_US.UTF-8"

    static VALUE frb_get_locale(VALUE self, VALUE locale)
    {
        return (frb_locale ? rb_str_new2(frb_locale) : Qnil);
    }

locale = "en_US.UTF-8" click to toggle source

Set the global locale. You should use this method to set different locales when indexing documents with different encodings.

    static VALUE frb_set_locale(VALUE self, VALUE locale)
    {
        char *l = ((locale == Qnil) ? NULL : rs2s(rb_obj_as_string(locale)));
        frb_locale = setlocale(LC_CTYPE, l);
        return frb_locale ? rb_str_new2(frb_locale) : Qnil;
    }

[Validate]

Generated with the Darkfish Rdoc Generator 2.