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) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandCustomHeader for RecallMessageRequestHeader

where CheetahString: HeaderValue, TopicRequestHeader: HeaderCodec, RecallMessageRequestHeader: 'static,

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

Checks the fields of the implementing type.

fn to_map(&self) -> Option<HeaderMap>

Converts the implementing type to a map.

fn encode_into_map(&self, out: &mut HeaderMap)

Appends this header’s extension fields to an existing map.

fn try_encode_into_map( &self, out: &mut HeaderMap, ) -> Result<(), ProtocolContractViolation>

Validates and appends this header’s fields to an existing map.

fn resolve_wire_key(&self, key: &str) -> Option<ResolvedHeaderKey>

Resolves a canonical key or decode alias for typed headers.

fn canonical_wire_key(&self, key: &str) -> Option<&'static str>

Resolves a key and returns its canonical wire key.

fn contains_wire_key(&self, key: &str) -> bool

Returns whether a canonical key or alias belongs to this header schema.

fn encoded_len_hint(&self) -> usize

Returns a saturating extension-field payload capacity hint.

fn encode_capability(&self) -> HeaderEncodeCapability

Returns the authoritative encoding path for this header.

fn encode_direct_binary( &self, _out: &mut BytesMut, ) -> Result<(), ProtocolContractViolation>

Appends this header directly to a ROCKETMQ extension-field payload.

fn supports_direct_json_fields(&self) -> bool

Returns whether this header can write its complete JSON extension-field object without first materializing a HeaderMap.

fn encode_direct_json_fields( &self, _out: &mut BytesMut, ) -> Result<(), ProtocolContractViolation>

Writes this header as one complete JSON extension-field object.

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)

Compatibility adapter for the legacy mutable fast-encoding API.

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

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, ) -> Result<CheetahString>

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

fn get_and_check_not_none_ref<'a>( &self, map: &'a HashMap<CheetahString, CheetahString>, field: &CheetahString, ) -> Result<&'a CheetahString>

Retrieves a borrowed 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() -> Self

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

where CheetahString: HeaderValue, TopicRequestHeader: HeaderCodec, RecallMessageRequestHeader: 'static,

const SUPPORTS_HEADER_FIELD_SOURCE: bool = true

Whether production decode may call Self::from_field_source without first materializing the compatibility map.

type Error = Error

type Target = RecallMessageRequestHeader

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

Converts the implementing type from a map.

fn from_field_source( source: &dyn HeaderFieldSource, ) -> Result<Self::Target, Self::Error>

Converts the implementing type from a borrowed field source.

impl HeaderCodec for RecallMessageRequestHeader

where CheetahString: HeaderValue, TopicRequestHeader: HeaderCodec, RecallMessageRequestHeader: 'static,

const TYPE_ID: &'static str = "rocketmq_protocol::protocol::header::recall_message_request_header::RecallMessageRequestHeader"

Stable, fully qualified Rust schema identifier.

const HEADER_NAME: &'static str = "RecallMessageRequestHeader"

Rust header name used in diagnostics.

const JAVA_CLASS: Option<&'static str>

Fully qualified Java peer when one is declared.

const FIELD_COUNT_HINT: usize

Recursive upper bound used to reserve map entries.

const LOCAL_FIELD_SPECS: &'static [HeaderFieldSpec]

Fields declared directly by this header, in stable binary order.

const LOCAL_FLATTEN_SPECS: &'static [HeaderFlattenSpec]

Flatten groups declared directly by this header, in stable binary order.

const FAST_ENABLED: bool = false

Whether direct binary generation was requested for the schema.

fn visit_field_specs(visitor: &mut dyn FnMut(&HeaderFieldSpec))

Visits field schemas declared here and recursively by flattened headers.

fn visit_flatten_specs(visitor: &mut dyn FnMut(&HeaderFlattenSpec))

Visits flatten schemas declared here and recursively by flattened headers.

fn resolve_wire_key(key: &str) -> Option<ResolvedHeaderKey>

Resolves a canonical key or alias to its owning typed field.

fn validate_for_wire(&self) -> Result<(), ProtocolContractViolation>

Validates this header layer before it writes to a wire destination.

fn encode_into<__RequestHeaderSink: EncodeSink>( &self, sink: &mut __RequestHeaderSink, ) -> Result<(), ProtocolContractViolation>

Appends canonical fields to a statically dispatched destination.

fn decode_from_map(map: &HeaderMap) -> Result<Self, ProtocolContractViolation>

Decodes this header from borrowed extension fields.

fn decode_from_source( source: &dyn HeaderFieldSource, ) -> Result<Self, ProtocolContractViolation>

Decodes this header directly from a borrowed field source.

fn contains_any_field(map: &HeaderMap) -> bool

Returns whether this header or any flattened child owns a present key.

fn encoded_len_hint(&self) -> usize

Estimates the encoded ROCKETMQ extension-field payload length.

fn contains_any_field_source(source: &dyn HeaderFieldSource) -> bool

Returns whether this header or a flattened child owns a source field.

fn canonical_wire_key(key: &str) -> Option<&'static str>

Resolves a key and returns its canonical wire key.

fn contains_wire_key(key: &str) -> bool

Returns whether a canonical key or alias belongs to this schema.

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.