Struct RecordHeaders 

pub struct RecordHeaders { /* private fields */ }

A mutable ordered collection of RecordHeader objects.

Note that multiple headers may have the same key. The order of headers is preserved in the order they were added.

Once set_read_only() is called, all mutating operations will return an error.

Corresponds to Java’s org.apache.kafka.common.header.internals.RecordHeaders.

Implementations

impl RecordHeaders

pub fn new() -> Self

Create an empty RecordHeaders.

Translates Java’s no-arg RecordHeaders() (RecordHeaders.java:35). The three Java constructors have no parameter in common, and the no-arg one matches that empty intersection, so it keeps the plain name under CLAUDE.md §2 — its two siblings are suffixed below.

pub fn with_header_slice(headers: &[RecordHeader]) -> Self

Create RecordHeaders from a slice of headers.

Translates Java’s RecordHeaders(Header[] headers) (RecordHeaders.java:39). Java’s other parameterised constructor names its parameter headers too, so the parameter name cannot tell them apart; per CLAUDE.md §2 the Rust parameter type discriminates, spelled as the caller writes it (&[RecordHeader] → _header_slice).

Panics

This corresponds to the Java behavior where null entries in the array cause a NullPointerException. In Rust, the Option type prevents null headers so this is safe by construction.

pub fn with_header_iter(headers: impl IntoIterator<Item = RecordHeader>) -> Self

Create RecordHeaders from headers.

Translates Java’s RecordHeaders(Iterable<Header> headers) (RecordHeaders.java:43) — see with_header_slice for why the type, not the parameter name, supplies the suffix.

pub fn with_record_headers(other: &RecordHeaders) -> Self

Create RecordHeaders by copying from another RecordHeaders.

Java reaches this through RecordHeaders(Iterable<Header> headers) (RecordHeaders.java:43), since RecordHeaders is itself an Iterable<Header>. Rust needs a distinct overload because &RecordHeaders iterates as &RecordHeader, not RecordHeader, so it does not satisfy with_header_iter’s bound. The suffix follows the type, as the sibling overloads do.

The new instance is writable regardless of the source’s read-only state.

pub fn set_read_only(&mut self)

Set the headers to read-only mode.

After calling this, all mutating operations will return an error.

pub fn is_read_only(&self) -> bool

Returns whether the headers are in read-only mode.

Trait Implementations

impl Clone for RecordHeaders

fn clone(&self) -> RecordHeaders

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecordHeaders

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

Formats the value using the given formatter.

impl Default for RecordHeaders

fn default() -> Self

Returns the “default value” for a type.

impl Display for RecordHeaders

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

Formats the value using the given formatter.

impl FromIterator<RecordHeader> for RecordHeaders

fn from_iter<I: IntoIterator<Item = RecordHeader>>(iter: I) -> Self

Creates a value from an iterator.

impl Hash for RecordHeaders

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 Headers for RecordHeaders

fn add_header( &mut self, header: RecordHeader, ) -> Result<(), LocalIllegalStateError>

Adds a header (key inside), to the end, returning if the operation succeeded.

fn add_key_value( &mut self, key: &str, value: Option<&[u8]>, ) -> Result<(), LocalIllegalStateError>

Creates and adds a header, to the end, returning if the operation succeeded.

fn remove(&mut self, key: &str) -> Result<(), LocalIllegalStateError>

Removes all headers for the given key returning if the operation succeeded, while preserving the insertion order of the remaining headers.

fn last_header(&self, key: &str) -> Option<&RecordHeader>

Returns just one (the very last) header for the given key, if present.

fn headers(&self, key: &str) -> Vec<&RecordHeader>

Returns all headers for the given key, in the order they were added in.

fn to_array(&self) -> &[RecordHeader]

Returns all headers as a slice.

fn iter(&self) -> Iter<'_, RecordHeader>

Returns an iterator over the headers.

impl<'a> IntoIterator for &'a RecordHeaders

type Item = &'a RecordHeader

The type of the elements being iterated over.

type IntoIter = Iter<'a, RecordHeader>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for RecordHeaders

fn eq(&self, other: &Self) -> 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 Eq for RecordHeaders