Struct RecallMessageRequestHeader 

pub struct RecallMessageRequestHeader {
    pub producer_group: Option<CheetahString>,
    pub topic: CheetahString,
    pub recall_handle: CheetahString,
    pub topic_request_header: Option<TopicRequestHeader>,
}

Request header for recalling (withdrawing) a message.

This header is used with RequestCode::RECALL_MESSAGE to recall a previously sent message from the broker. The recall operation requires the producer group, topic, and a recall handle that identifies the message to be recalled.

Fields

producer_group: Option<CheetahString>

Producer group name (optional).

The name of the producer group that originally sent the message. This may be omitted in some scenarios where the recall handle alone is sufficient to identify the message.

topic: CheetahString

Topic name (required).

The topic to which the message was originally sent.

recall_handle: CheetahString

Recall handle (required).

A unique identifier or handle that specifies which message to recall. The format and semantics of this handle are implementation-specific.

topic_request_header: Option<TopicRequestHeader>

Topic request header containing common request metadata.

This field is flattened during serialization/deserialization to merge its fields with the top-level structure.

Implementations

impl RecallMessageRequestHeader

pub fn new( topic: impl Into<CheetahString>, recall_handle: impl Into<CheetahString>, producer_group: Option<impl Into<CheetahString>>, ) -> Self

Creates a new RecallMessageRequestHeader with the specified values.

Arguments

• topic - The topic name
• recall_handle - The recall handle identifying the message
• producer_group - Optional producer group name

Returns

A new RecallMessageRequestHeader instance

pub fn producer_group(&self) -> Option<&CheetahString>

Gets a reference to the producer group, if set.

pub fn set_producer_group(&mut self, producer_group: impl Into<CheetahString>)

Sets the producer group.

pub fn topic(&self) -> &CheetahString

Gets a reference to the topic.

pub fn set_topic(&mut self, topic: impl Into<CheetahString>)

Sets the topic.

pub fn recall_handle(&self) -> &CheetahString

Gets a reference to the recall handle.

pub fn set_recall_handle(&mut self, recall_handle: impl Into<CheetahString>)

Sets the recall handle.

Trait Implementations

impl Clone for RecallMessageRequestHeader

fn clone(&self) -> RecallMessageRequestHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandCustomHeader for RecallMessageRequestHeader

fn to_map(&self) -> Option<HashMap<CheetahString, CheetahString>>

Converts the implementing type to a map.

fn check_fields(&self) -> Result<(), Error>

Checks the fields of the implementing type.

fn write_if_not_null(&self, out: &mut BytesMut, key: &str, value: &str)

Writes the provided key to the out buffer if the value is not empty.

fn encode_fast(&mut self, _out: &mut BytesMut)

A placeholder function for fast encoding.

fn decode_fast( &mut self, _fields: &HashMap<CheetahString, CheetahString>, ) -> RocketMQResult<()>

A placeholder function for fast decoding.

fn support_fast_codec(&self) -> bool

Indicates whether the implementing type supports fast codec.

fn get_and_check_not_none( &self, map: &HashMap<CheetahString, CheetahString>, field: &CheetahString, ) -> RocketMQResult<CheetahString>

Retrieves the value associated with the specified field from the provided map.

impl Debug for RecallMessageRequestHeader

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

Formats the value using the given formatter.

impl Default for RecallMessageRequestHeader

fn default() -> RecallMessageRequestHeader

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RecallMessageRequestHeader

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RecallMessageRequestHeader

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

Formats the value using the given formatter.

impl FromMap for RecallMessageRequestHeader

type Error = RocketMQError

type Target = RecallMessageRequestHeader

fn from( map: &HashMap<CheetahString, CheetahString>, ) -> Result<Self::Target, Self::Error>

Converts the implementing type from a map.

impl Serialize for RecallMessageRequestHeader

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

where __S: Serializer,

Serialize this value into the given Serde serializer.