Struct RemotingCommandCodec

pub struct RemotingCommandCodec(/* private fields */);

Encodes a RemotingCommand into a BytesMut buffer.

This method takes a RemotingCommand and a mutable reference to a BytesMut buffer as parameters. It first encodes the header of the RemotingCommand and calculates the lengths of the header and body. It then reserves the necessary space in the BytesMut buffer and writes the total length, serialize type, header, and body to the buffer.

Arguments

• item - A RemotingCommand that is to be encoded.
• dst - A mutable reference to a BytesMut buffer where the encoded command will be written.

Returns

• Result<(), Self::Error> - Returns Ok(()) if the encoding is successful, otherwise returns an Err with a RemotingError.

Errors

This function will return an error if the encoding process fails.

Implementations

impl RemotingCommandCodec

pub fn new() -> Self

Trait Implementations

impl Clone for RemotingCommandCodec

fn clone(&self) -> RemotingCommandCodec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RemotingCommandCodec

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

Formats the value using the given formatter.

impl Decoder for RemotingCommandCodec

fn decode( &mut self, src: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

Decodes a RemotingCommand from a BytesMut buffer.

This method takes a mutable reference to a BytesMut buffer as a parameter. It first checks if there are at least 4 bytes in the buffer, if not, it returns Ok(None). Then it reads the total size of the incoming data as a big-endian i32 from the first 4 bytes. If the available data is less than the total size, it returns Ok(None). It then splits the BytesMut buffer to get the command data including the total size and discards the first i32 (total size). It reads the header length as a big-endian i32 and checks if the header length is greater than the total size minus 4. If it is, it returns an error. It then splits the buffer again to get the header data and deserializes it into a RemotingCommand. If the total size minus 4 is greater than the header length, it sets the body of the RemotingCommand.

Arguments

• src - A mutable reference to a BytesMut buffer from which the RemotingCommand will be decoded.

Returns

• Result<Option<Self::Item>, Self::Error> - Returns Ok(Some(cmd)) if the decoding is successful, otherwise returns an Err with a RemotingError.

Errors

This function will return an error if the decoding process fails.

type Error = RocketmqError

The type of unrecoverable frame decoding errors.

type Item = RemotingCommand

The type of decoded frames.

fn decode_eof( &mut self, buf: &mut BytesMut, ) -> Result<Option<Self::Item>, Self::Error>

A default method available to be called when there are no more bytes available to be read from the underlying I/O.

fn framed<T>(self, io: T) -> Framed<T, Self>

where T: AsyncRead + AsyncWrite, Self: Sized,

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

impl Default for RemotingCommandCodec

fn default() -> Self

Returns the “default value” for a type.

impl Encoder<RemotingCommand> for RemotingCommandCodec

fn encode( &mut self, item: RemotingCommand, dst: &mut BytesMut, ) -> Result<(), Self::Error>

Encodes a RemotingCommand into a BytesMut buffer.

This method takes a RemotingCommand and a mutable reference to a BytesMut buffer as parameters. It first encodes the header of the RemotingCommand and calculates the lengths of the header and body. It then reserves the necessary space in the BytesMut buffer and writes the total length, serialize type, header, and body to the buffer.

Arguments

• item - A RemotingCommand that is to be encoded.
• dst - A mutable reference to a BytesMut buffer where the encoded command will be written.

Returns

• Result<(), Self::Error> - Returns Ok(()) if the encoding is successful, otherwise returns an Err with a RemotingError.

Errors

This function will return an error if the encoding process fails.

type Error = RocketmqError

The type of encoding errors.

impl Hash for RemotingCommandCodec

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RemotingCommandCodec

fn cmp(&self, other: &RemotingCommandCodec) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RemotingCommandCodec

fn eq(&self, other: &RemotingCommandCodec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for RemotingCommandCodec

fn partial_cmp(&self, other: &RemotingCommandCodec) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for RemotingCommandCodec

impl Eq for RemotingCommandCodec

impl StructuralPartialEq for RemotingCommandCodec