Struct rdkafka::message::OwnedHeaders

pub struct OwnedHeaders { /* private fields */ }

A collection of Kafka message headers that owns its backing data.

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.

Implementations

impl OwnedHeaders

pub fn new() -> OwnedHeaders

Creates a new OwnedHeaders struct with initial capacity 5.

pub fn new_with_capacity(initial_capacity: usize) -> OwnedHeaders

Creates 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

Adds a new header.

pub fn as_borrowed(&self) -> &BorrowedHeaders

Generates a read-only BorrowedHeaders reference.

Trait Implementations

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 Debug for OwnedHeaders

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

Formats the value using the given formatter.

impl Default for OwnedHeaders

fn default() -> OwnedHeaders

Returns the “default value” for a type.

impl Headers for OwnedHeaders

fn count(&self) -> usize

Returns the number of contained headers.

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

Gets the specified header, where the first header corresponds to index 0. If the index is out of bounds, returns None.

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

Like Headers::get, but the value of the header will be converted to the specified type. If the conversion fails, returns an error.

impl Send for OwnedHeaders

impl Sync for OwnedHeaders