Struct commitlog::message::MessageBuf

pub struct MessageBuf { /* fields omitted */ }

Mutable message buffer.

The buffer will handle the serialization of the message into the proper format expected by the CommitLog.

Implementations

impl MessageBuf

pub fn from_bytes(bytes: Vec<u8>) -> Result<MessageBuf, MessageError>

Creates a message buffer from a previously serialized vector of bytes. Integrity checking is performed on the vector to ensure that it was properly serialized.

pub fn clear(&mut self)

Clears the message buffer.

pub unsafe fn unsafe_clear(&mut self)

Clears the message buffer without dropping the contents.

pub fn into_bytes(self) -> Vec<u8>

Moves the underlying serialized bytes into a vector.

pub fn push<B: AsRef<[u8]>>(
    &mut self,
    payload: B
) -> Result<(), MessageSerializationError>

Adds a new message to the buffer.

pub fn push_with_metadata<M: AsRef<[u8]>, B: AsRef<[u8]>>(
    &mut self,
    metadata: M,
    payload: B
) -> Result<(), MessageSerializationError>

Adds a new message with metadata.

pub fn read<R: Read>(&mut self, reader: &mut R) -> Result<(), MessageError>

Reads a single message. The reader is expected to have a full message serialized.

Trait Implementations

impl Default for MessageBuf

fn default() -> MessageBuf

Returns the “default value” for a type.

impl<R: AsRef<[u8]>> FromIterator<R> for MessageBuf

fn from_iter<T>(iter: T) -> MessageBuf where
    T: IntoIterator<Item = R>, 

Creates a value from an iterator.

impl MessageSet for MessageBuf

fn bytes(&self) -> &[u8]

Bytes that make up the serialized message set.

fn len(&self) -> usize

Number of messages in the message set.

fn iter(&self) -> MessageIter<'_>

Iterator on the messages in the message set.

fn is_empty(&self) -> bool

Indicator of whether there are messages within the MessageSet.

fn verify_hashes(&self) -> Result<(), usize>

Verifies the hashes of all the messages, returning the index of a corrupt message when found.

impl MessageSetMut for MessageBuf

fn bytes_mut(&mut self) -> &mut [u8]

Bytes of the buffer for mutation.

fn iter_mut(&mut self) -> MessageMutIter<'_>

Mutable iterator