Struct QueryFilter

pub struct QueryFilter {
    pub allow_documents: bool,
    pub allow_paragraphs: bool,
    pub allow_definitions: bool,
    pub allow_examples: bool,
    pub allow_assertions: bool,
    pub allow_problems: bool,
    pub definition_like_only: bool,
}

Fields

allow_documents: bool

allow_paragraphs: bool

allow_definitions: bool

allow_examples: bool

allow_assertions: bool

allow_problems: bool

definition_like_only: bool

Implementations

impl QueryFilter

pub fn to_query(self, query: &str, index: &Index) -> Option<Box<dyn Query>>

Available on crate feature tantivy only.

Trait Implementations

impl Clone for QueryFilter

fn clone(&self) -> QueryFilter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QueryFilter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for QueryFilter

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for QueryFilter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<QueryFilter> for JsValue

where QueryFilter: Serialize,

fn from(value: QueryFilter) -> Self

Converts to this type from the input type.

impl FromWasmAbi for QueryFilter

where Self: DeserializeOwned,

type Abi = <JsType as FromWasmAbi>::Abi

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for QueryFilter

where QueryFilter: Serialize,

type Abi = <JsType as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl OptionFromWasmAbi for QueryFilter

where Self: DeserializeOwned,

fn is_none(js: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for QueryFilter

where QueryFilter: Serialize,

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl PartialEq for QueryFilter

fn eq(&self, other: &QueryFilter) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefFromWasmAbi for QueryFilter

where Self: DeserializeOwned,

type Abi = <JsType as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = SelfOwner<QueryFilter>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl Serialize for QueryFilter

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Tsify for QueryFilter

const DECL: &'static str = "export interface QueryFilter {\n allow_documents?: boolean;\n allow_paragraphs?: boolean;\n allow_definitions?: boolean;\n allow_examples?: boolean;\n allow_assertions?: boolean;\n allow_problems?: boolean;\n definition_like_only?: boolean;\n}"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

fn into_js(&self) -> Result<Self::JsType, Error>

where Self: Serialize,

fn from_js<T>(js: T) -> Result<Self, Error>

where T: Into<JsValue>, Self: DeserializeOwned,

impl VectorFromWasmAbi for QueryFilter

where Self: DeserializeOwned,

type Abi = <JsType as VectorFromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[Self]>

impl VectorIntoWasmAbi for QueryFilter

where QueryFilter: Serialize,

type Abi = <JsType as VectorIntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[Self]>) -> Self::Abi

impl WasmDescribe for QueryFilter

fn describe()

impl WasmDescribeVector for QueryFilter

fn describe_vector()

impl Copy for QueryFilter

impl Eq for QueryFilter

impl StructuralPartialEq for QueryFilter