Skip to main content

Message

Struct Message 

Source
pub struct Message {
    pub payload: Vec<u8>,
    pub content_type: ContentType,
    pub context: MessageContext,
    pub ack_handle: Option<Arc<dyn MessageAck>>,
}
Expand description

通用的 MQ 消息类型

支持多种序列化格式(JSON、Protobuf、Avro 等)

Fields§

§payload: Vec<u8>

原始消息内容

§content_type: ContentType

序列化格式

§context: MessageContext

消息上下文

§ack_handle: Option<Arc<dyn MessageAck>>

Broker ack handle. JetStream auto-commit paths may leave this empty; JetStream uses it so ack/nack happens after handler result instead of at fetch time.

Implementations§

Source§

impl Message

Source

pub fn new( payload: Vec<u8>, content_type: ContentType, context: MessageContext, ) -> Message

创建新的消息

Source

pub fn with_ack_handle(self, ack_handle: Arc<dyn MessageAck>) -> Message

Source

pub fn to_json<T>(&self) -> Result<T, ConsumerError>

反序列化为 JSON(带格式校验)

会校验 content-type 是否为 JSON,用于防御性编程

Source

pub fn decode_json<T>(&self) -> Result<T, ConsumerError>

直接反序列化为 JSON(不校验格式)

推荐使用此方法,因为:

  1. payload 已经是序列化好的数据,直接解码即可
  2. 避免不必要的 content-type 校验开销
  3. 如果解码失败,serde_json 本身会返回错误
§示例
ⓘ
let data = message.decode_json::<MyData>()?;
Source

pub fn to_protobuf<T>(&self) -> Result<T, ConsumerError>
where T: Message + Default,

反序列化为 Protobuf(带格式校验)

会校验 content-type 是否为 Protobuf,用于防御性编程

Source

pub fn decode_protobuf<T>(&self) -> Result<T, ConsumerError>
where T: Message + Default,

直接反序列化为 Protobuf(不校验格式)

推荐使用此方法,因为:

  1. payload 已经是序列化好的二进制,直接解码即可
  2. 避免不必要的 content-type 校验开销
  3. 如果解码失败,Protobuf 本身会返回错误
§示例
ⓘ
let envelope = message.decode_protobuf::<MqEnvelope>()?;
Source

pub fn to_string(&self) -> Result<String, ConsumerError>

获取原始字符串

Trait Implementations§

Source§

impl Clone for Message

Source§

fn clone(&self) -> Message

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 Message

Source§

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

Formats the value using the given formatter. 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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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, 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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