Struct MetadataRequest

#[non_exhaustive]
pub struct MetadataRequest {
    pub topics: Option<Vec<MetadataRequestTopic>>,
    pub allow_auto_topic_creation: bool,
    pub include_cluster_authorized_operations: bool,
    pub include_topic_authorized_operations: bool,
    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
}

Valid versions: 0-12

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.

topics: Option<Vec<MetadataRequestTopic>>

The topics to fetch metadata for.

Supported API versions: 0-12

allow_auto_topic_creation: bool

If this is true, the broker may auto-create topics that we requested which do not already exist, if it is configured to do so.

Supported API versions: 4-12

include_cluster_authorized_operations: bool

Whether to include cluster authorized operations.

Supported API versions: 8-10

include_topic_authorized_operations: bool

Whether to include topic authorized operations.

Supported API versions: 8-12

unknown_tagged_fields: BTreeMap<i32, Bytes>

Other tagged fields

Implementations

impl MetadataRequest

pub fn with_topics(self, value: Option<Vec<MetadataRequestTopic>>) -> Self

Sets topics to the passed value.

The topics to fetch metadata for.

Supported API versions: 0-12

pub fn with_allow_auto_topic_creation(self, value: bool) -> Self

Sets allow_auto_topic_creation to the passed value.

If this is true, the broker may auto-create topics that we requested which do not already exist, if it is configured to do so.

Supported API versions: 4-12

pub fn with_include_cluster_authorized_operations(self, value: bool) -> Self

Sets include_cluster_authorized_operations to the passed value.

Whether to include cluster authorized operations.

Supported API versions: 8-10

pub fn with_include_topic_authorized_operations(self, value: bool) -> Self

Sets include_topic_authorized_operations to the passed value.

Whether to include topic authorized operations.

Supported API versions: 8-12

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 MetadataRequest

fn clone(&self) -> MetadataRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetadataRequest

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

Formats the value using the given formatter.

impl Decodable for MetadataRequest

Available on crate feature broker only.

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

Decode the message from the provided buffer and version.

impl Default for MetadataRequest

fn default() -> Self

Returns the “default value” for a type.

impl Encodable for MetadataRequest

Available on crate feature client only.

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 From<MetadataRequest> for RequestKind

Available on crate feature messages_enums only.

fn from(value: MetadataRequest) -> RequestKind

Converts to this type from the input type.

impl HeaderVersion for MetadataRequest

fn header_version(version: i16) -> i16

Maps a header version to a given version for a particular API message.

impl Message for MetadataRequest

const VERSIONS: VersionRange

The valid versions for this message.

const DEPRECATED_VERSIONS: Option<VersionRange>

The deprecated versions for this message.

impl PartialEq for MetadataRequest

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

Available on crate features client and broker only.

const KEY: i16 = 3i16

The API key of this request.

type Response = MetadataResponse

The response associated with this request.

impl StructuralPartialEq for MetadataRequest