Struct rdkafka::admin::AdminOptions

pub struct AdminOptions { /* private fields */ }

Options for an admin API request.

Implementations

impl AdminOptions

pub fn new() -> AdminOptions

Creates a new AdminOptions.

pub fn request_timeout<T: Into<Timeout>>(self, timeout: Option<T>) -> Self

Sets the overall request timeout, including broker lookup, request transmission, operation time on broker, and response.

Defaults to the socket.timeout.ms configuration parameter.

pub fn operation_timeout<T: Into<Timeout>>(self, timeout: Option<T>) -> Self

Sets the broker’s operation timeout, such as the timeout for CreateTopics to complete the creation of topics on the controller before returning a result to the application.

If unset (the default), the API calls will return immediately after triggering the operation.

Only the CreateTopics, DeleteTopics, and CreatePartitions API calls respect this option.

pub fn validate_only(self, validate_only: bool) -> Self

Tells the broker to only validate the request, without performing the requested operation.

Defaults to false.

pub fn broker_id<T: Into<Option<i32>>>(self, broker_id: T) -> Self

Override what broker the admin request will be sent to.

By default, a reasonable broker will be selected automatically. See the librdkafka docs on rd_kafka_AdminOptions_set_broker for details.

Trait Implementations

impl Default for AdminOptions

fn default() -> AdminOptions

Returns the “default value” for a type.