pub struct ConnectionOptions {Show 15 fields
pub client_id: String,
pub dns_timeout: ClientDnsTimeout,
pub socket_connection_setup_timeout: Time,
pub socket_connection_setup_timeout_max: Time,
pub reconnect_backoff: Time,
pub reconnect_backoff_max: Time,
pub connections_max_idle: Time,
pub client_dns_lookup: ClientDnsLookup,
pub send_buffer: Option<ByteSize>,
pub receive_buffer: Option<ByteSize>,
pub request_timeout: Time,
pub dispatch_queue_capacity: ConnectionDispatchQueueCapacity,
pub frame_max: ClientFrameMax,
pub security: Option<Box<ClientSecurity>>,
pub network_metrics: Option<NetworkMetrics>,
}Expand description
Connect-time + per-request configuration knobs.
Fields§
§client_id: String§dns_timeout: ClientDnsTimeout§socket_connection_setup_timeout: TimeThe TCP connect deadline of one attempt
(socket.connection.setup.timeout.ms). The broker pool doubles it,
with jitter, for each failed attempt to the same broker, up to
Self::socket_connection_setup_timeout_max.
socket_connection_setup_timeout_max: Timesocket.connection.setup.timeout.max.ms.
reconnect_backoff: TimeThe wait before the broker pool connects again to a broker after a
failure or a disconnect (reconnect.backoff.ms). It doubles, with
jitter, for each failure in a row.
reconnect_backoff_max: Timereconnect.backoff.max.ms.
connections_max_idle: TimeThe connection closes after this time with no request and no response
(connections.max.idle.ms).
client_dns_lookup: ClientDnsLookupclient.dns.lookup.
send_buffer: Option<ByteSize>The socket send buffer (send.buffer.bytes). None keeps the
operating system default, as Kafka’s -1 does.
receive_buffer: Option<ByteSize>The socket receive buffer (receive.buffer.bytes). None keeps the
operating system default.
request_timeout: Time§dispatch_queue_capacity: ConnectionDispatchQueueCapacity§frame_max: ClientFrameMax§security: Option<Box<ClientSecurity>>Client-side TLS/SASL policy. None = plaintext (default).
This field is boxed so ConnectionOptions stays small. Many call
sites clone ConnectionOptions and embed it in connection-building
futures, and ClientSecurity carries several String/PathBuf
fields that would otherwise make every such future large.
network_metrics: Option<NetworkMetrics>The network metrics of a client that pushes its metrics (KIP-714).
Connection::connect_with_options counts the new connection in
them. None counts nowhere.
Implementations§
Source§impl ConnectionOptions
impl ConnectionOptions
Sourcepub fn validate(&self) -> Result<(), String>
pub fn validate(&self) -> Result<(), String>
Validate transport budgets before converting durations or opening sockets.
§Errors
Rejects nonfinite, unrepresentable or invalid durations, inverted retry
bounds, nonpositive or fractional socket buffer sizes, and a SASL
mechanism this build cannot run: GSSAPI without the gssapi feature.
Trait Implementations§
Source§impl Clone for ConnectionOptions
impl Clone for ConnectionOptions
Source§fn clone(&self) -> ConnectionOptions
fn clone(&self) -> ConnectionOptions
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ConnectionOptions
impl Debug for ConnectionOptions
Auto Trait Implementations§
impl !RefUnwindSafe for ConnectionOptions
impl !UnwindSafe for ConnectionOptions
impl Freeze for ConnectionOptions
impl Send for ConnectionOptions
impl Sync for ConnectionOptions
impl Unpin for ConnectionOptions
impl UnsafeUnpin for ConnectionOptions
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling [Attribute] value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi [Quirk] value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the [Condition] value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);