Struct rdkafka::admin::AdminOptions

source ·
pub struct AdminOptions { /* private fields */ }
Expand description

Options for an admin API request.

Implementations§

source§

impl AdminOptions

source

pub fn new() -> AdminOptions

Creates a new AdminOptions.

source

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.

source

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.

source

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.

source

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§

source§

impl Default for AdminOptions

source§

fn default() -> AdminOptions

Returns the “default value” for a type. 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> 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, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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