rocketmq-store 0.3.0

/*
 * 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 std::collections::HashMap;

use cheetah_string::CheetahString;

use crate::consume_queue::consume_queue_ext::CqExtUnit;

/// Represents a message filter.
pub trait MessageFilter: Send + Sync {
    /// Matches by tags code or filter bit map which is calculated when the message is received
    /// and stored in consume queue ext.
    fn is_matched_by_consume_queue(
        &self,
        tags_code: Option<i64>,
        cq_ext_unit: Option<&CqExtUnit>,
    ) -> bool;

    /// Matches by message content which is stored in the commit log.
    ///
    /// `msg_buffer`: Message buffer in the commit log, may be `None` if not invoked in store.
    /// `properties`: Message properties, should be decoded from the buffer if `None`.
    fn is_matched_by_commit_log(
        &self,
        msg_buffer: Option<&[u8]>,
        properties: Option<&HashMap<CheetahString, CheetahString>>,
    ) -> bool;
}