Skip to main content

MessageBatchV2

Struct MessageBatchV2 

Source
pub struct MessageBatchV2 { /* private fields */ }
Expand description

Batch message container

Used for sending multiple messages in batch. Requires all messages to have the same topic and send properties.

§Constraints

  • All messages must have the same topic
  • All messages must have the same wait_store_msg_ok property
  • Delayed messages are not supported
  • Retry topics are not supported

§Examples

use rocketmq_model::common::message::message_batch_v2::MessageBatchV2;
use rocketmq_model::common::message::message_single::Message;

let msg1 = Message::builder()
    .topic("TopicTest")
    .body_slice(b"Hello")
    .build_unchecked();
let msg2 = Message::builder()
    .topic("TopicTest")
    .body_slice(b"World")
    .build_unchecked();

let batch = MessageBatchV2::new(vec![msg1, msg2]).unwrap();
assert_eq!(batch.len(), 2);
assert_eq!(batch.topic().as_str(), "TopicTest");

Implementations§

Source§

impl MessageBatchV2

Source

pub fn new(messages: Vec<Message>) -> Result<Self>

Creates a batch message

§Errors
  • Message list is empty
  • Messages have different topics
  • Contains delayed messages
  • Contains retry topics
  • wait_store_msg_ok properties are inconsistent
Source

pub fn topic(&self) -> &CheetahString

Gets the batch message topic

Source

pub fn wait_store_msg_ok(&self) -> bool

Whether to wait for storage completion

Source

pub fn len(&self) -> usize

Gets the number of batch messages

Source

pub fn is_empty(&self) -> bool

Checks if the batch is empty

Source

pub fn iter(&self) -> impl Iterator<Item = &Message>

Iterates over all messages

Source

pub fn messages(&self) -> &[Message]

Gets a reference to the message list

Source

pub fn into_messages(self) -> Vec<Message>

Consumes the batch and returns the internal message list

Trait Implementations§

Source§

impl Clone for MessageBatchV2

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MessageBatchV2

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for MessageBatchV2

Source§

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

Formats the value using the given formatter. Read more
Source§

impl IntoIterator for MessageBatchV2

Source§

type IntoIter = IntoIter<Message>

Which kind of iterator are we turning this into?
Source§

type Item = Message

The type of the elements being iterated over.
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<'a> IntoIterator for &'a MessageBatchV2

Source§

type IntoIter = Iter<'a, Message>

Which kind of iterator are we turning this into?
Source§

type Item = &'a Message

The type of the elements being iterated over.
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more