Struct rdkafka::message::OwnedHeaders

pub struct OwnedHeaders { /* fields omitted */ }

Owned message headers

Kafka supports associating an array of key-value pairs to every message, called message headers. The OwnedHeaders can be used to create the desired headers and to pass them to the producer. See also BorrowedHeaders.

Methods

impl OwnedHeaders

pub fn new() -> OwnedHeaders

Create a new OwnedHeaders struct with initial capacity 5.

pub fn new_with_capacity(initial_capacity: usize) -> OwnedHeaders

Create a new OwnedHeaders struct with the desired initial capacity. The structure is automatically resized as more headers are added.

pub fn add<V: ToBytes + ?Sized>(self, name: &str, value: &V) -> OwnedHeaders

Add a new header to the structure.

pub fn as_borrowed(&self) -> &BorrowedHeaders

Generate a read-only BorrowedHeaders reference.

Trait Implementations

impl Headers for OwnedHeaders

fn count(&self) -> usize

Return the number of defined headers.

fn get(&self, idx: usize) -> Option<(&str, &[u8])>

Get the specified header (the first header corresponds to index 0). If the index is out of bounds, None is returned.

fn get_as<V: FromBytes + ?Sized>(
    &self,
    idx: usize
) -> Option<(&str, Result<&V, V::Error>)>

Same as Headers::get, but the value of the header will be converted to the specified type. If the conversion fails, an error will be returned instead.

impl Clone for OwnedHeaders

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Send for OwnedHeaders

impl Drop for OwnedHeaders

fn drop(&mut self)

Executes the destructor for this type.

impl Debug for OwnedHeaders

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

Formats the value using the given formatter.