Struct RequestHeader

#[non_exhaustive]
pub struct RequestHeader {
    pub request_api_key: i16,
    pub request_api_version: i16,
    pub correlation_id: i32,
    pub client_id: Option<StrBytes>,
    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
}

Valid versions: 0-2

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

request_api_key: i16

The API key of this request.

Supported API versions: 0-2

request_api_version: i16

The API version of this request.

Supported API versions: 0-2

correlation_id: i32

The correlation ID of this request.

Supported API versions: 0-2

client_id: Option<StrBytes>

The client ID string.

Supported API versions: 1-2

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl RequestHeader

pub fn with_request_api_key(self, value: i16) -> Self

Sets request_api_key to the passed value.

The API key of this request.

Supported API versions: 0-2

pub fn with_request_api_version(self, value: i16) -> Self

Sets request_api_version to the passed value.

The API version of this request.

Supported API versions: 0-2

pub fn with_correlation_id(self, value: i32) -> Self

Sets correlation_id to the passed value.

The correlation ID of this request.

Supported API versions: 0-2

pub fn with_client_id(self, value: Option<StrBytes>) -> Self

Sets client_id to the passed value.

The client ID string.

Supported API versions: 1-2

pub fn with_unknown_tagged_fields(self, value: BTreeMap<i32, Bytes>) -> Self

Sets unknown_tagged_fields to the passed value.

pub fn with_unknown_tagged_field(self, key: i32, value: Bytes) -> Self

Inserts an entry into unknown_tagged_fields.

Trait Implementations

impl Clone for RequestHeader

fn clone(&self) -> RequestHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RequestHeader

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

Formats the value using the given formatter.

impl Decodable for RequestHeader

fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self>

Decode the message from the provided buffer and version.

impl Default for RequestHeader

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for RequestHeader

fn encode<B: ByteBufMut>(&self, buf: &mut B, version: i16) -> Result<()>

Encode the message into the target buffer.

fn compute_size(&self, version: i16) -> Result<usize>

Compute the total size of the message when encoded.

impl Message for RequestHeader

const VERSIONS: VersionRange

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange> = None

The deprecated versions for this message.

impl PartialEq for RequestHeader

fn eq(&self, other: &RequestHeader) -> 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 StructuralPartialEq for RequestHeader