rocketmq-store 0.6.0

Storage layer for Apache RocketMQ in Rust.
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 std::collections::HashMap;

use cheetah_string::CheetahString;

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

/// A trait for filtering messages.
pub trait MessageFilter: Send + Sync {
    /// Checks if the message is matched by the consume queue.
    ///
    /// # Arguments
    ///
    /// * `tags_code` - An optional tag code.
    /// * `cq_ext_unit` - An optional reference to a `CqExtUnit`.
    ///
    /// # Returns
    ///
    /// * `true` if the message is matched, `false` otherwise.
    fn is_matched_by_consume_queue(
        &self,
        tags_code: Option<i64>,
        cq_ext_unit: Option<&CqExtUnit>,
    ) -> bool;

    /// Checks if the message is matched by the commit log.
    ///
    /// # Arguments
    ///
    /// * `msg_buffer` - An optional mutable reference to a message buffer.
    /// * `properties` - An optional reference to a map of properties.
    ///
    /// # Returns
    ///
    /// * `true` if the message is matched, `false` otherwise.
    fn is_matched_by_commit_log(
        &self,
        msg_buffer: Option<&[u8]>,
        properties: Option<&HashMap<CheetahString, CheetahString>>,
    ) -> bool;
}