Skip to main content

RequestHeader

Struct RequestHeader 

Source
pub struct RequestHeader {
    pub api_key: i16,
    pub api_version: i16,
    pub correlation_id: i32,
    pub client_id: Option<String>,
}
Expand description

Kafka request header (api_key through client_id, plus tagged fields when flexible).

std::fmt::Display is Java RequestHeader.toString: RequestHeader(apiKey=PRODUCE, apiVersion=9, clientId=client, correlationId=1, headerVersion=2). apiKey is the Kafka 4.0 ApiKeys enum name (not ApiMessageType.name). Null clientId prints null; an empty id prints empty. Self::size is Java RequestHeader.size.

Fields§

§api_key: i16

Api key.

§api_version: i16

Api version.

§correlation_id: i32

Correlation id echoed on the response.

§client_id: Option<String>

Kafka client.id, or None for a null string.

Implementations§

Source§

impl RequestHeader

Source

pub const fn api_key(&self) -> i16

Java RequestHeader.apiKey id.

Source

pub const fn api_version(&self) -> i16

Java RequestHeader.apiVersion.

Source

pub const fn correlation_id(&self) -> i32

Java RequestHeader.correlationId.

Source

pub fn client_id(&self) -> Option<&str>

Java RequestHeader.clientId (None is Java null).

Source

pub fn header_version(&self) -> i16

Java RequestHeader.headerVersion.

Source

pub fn size(&self) -> i32

Java RequestHeader.size.

Serialized bytes: INT16 api key, INT16 api version, INT32 correlation id, classic nullable STRING clientId, plus one empty tagged-fields unsigned varint when Self::header_version is 2. Matches encode_request_header.

Source

pub const fn to_response_header(&self) -> ResponseHeader

Java RequestHeader.toResponseHeader.

Copies Self::correlation_id. Java also stores apiKey.responseHeaderVersion(apiVersion) on the result; this crate’s ResponseHeader only has correlationId.

Source

pub fn check_correlation(&self, response: &ResponseHeader) -> Result<()>

Java AbstractResponse.parseResponse correlation-id check (CorrelationIdMismatchException).

Trait Implementations§

Source§

impl Clone for RequestHeader

Source§

fn clone(&self) -> RequestHeader

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RequestHeader

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for RequestHeader

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more