rlucene 0.1.0-alpha.3

A Rust port of Apache Lucene, a full-text search engine library
Documentation
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
use crate::core::util::attribute::Attribute;

/// This attribute can be used to pass different flags down the [`Tokenizer`](crate::core::analysis::tokenizer::Tokenizer) chain, e.g. from
/// one [`TokenFilter`](crate::core::analysis::token_filter::TokenFilter) to another one.
///
/// This is completely distinct from [`TypeAttribute`](crate::core::analysis::token_attributes::type_attribute::TypeAttribute), although they do share similar
/// purposes. The flags can be used to encode information about the token for use by other
/// [`TokenFilter`](crate::core::analysis::token_filter::TokenFilter)s.
pub trait FlagsAttribute: Attribute {
  #[cfg(any(test, debug_assertions))]
  const ATTRIBUTE_NAME: &'static str = NAME;

  /// Get the bitset for any bits that have been set.
  fn get_flags(&self) -> i32;
  /// Set the flags to a new bitset.
  fn set_flags(&mut self, flags: i32);
}

pub const NAME: &str = "FlagsAttribute";