Struct nakadion::consumer::ConnectConfig

pub struct ConnectConfig {
    pub stream_parameters: StreamParameters,
    pub abort_on_auth_error: Option<ConnectAbortOnAuthError>,
    pub abort_on_conflict: Option<ConnectAbortOnConflict>,
    pub abort_connect_on_subscription_not_found: Option<ConnectAbortOnSubscriptionNotFound>,
    pub timeout_secs: Option<ConnectTimeout>,
    pub max_retry_delay_secs: Option<ConnectMaxRetryDelaySecs>,
    pub attempt_timeout_secs: Option<ConnectAttemptTimeoutSecs>,
}

Parameters to configure the Connector

See also Nakadi Manual

Example

use nakadion::components::connector::{ConnectConfig, ConnectTimeout};

let cfg = ConnectConfig::default()
    .abort_on_auth_error(true)
    .timeout_secs(25u64);

assert_eq!(cfg.abort_on_auth_error, Some(true.into()));
assert_eq!(cfg.timeout_secs, Some(ConnectTimeout::Seconds(25)));

Fields

stream_parameters: StreamParameters

StreamParameters used to configure the stream consumed from Nakadi

abort_on_auth_error: Option<ConnectAbortOnAuthError>

If set to true auth error will not cause a retry on connect attempts

abort_on_conflict: Option<ConnectAbortOnConflict>

If set to true conflicts (Status 409) will not cause a retry on connect attempts

abort_connect_on_subscription_not_found: Option<ConnectAbortOnSubscriptionNotFound>

If true abort the consumer when a subscription does not exist when connection to a stream.

It can make sense if the subscription is expected to not already be there on startup and waiting for it to became available is intended.

The default is true

timeout_secs: Option<ConnectTimeout>

The maximum time for until a connection to a stream has to be established.

When elapsed and no stream could be connected to, the Connector fails

Default is to retry indefinitely

max_retry_delay_secs: Option<ConnectMaxRetryDelaySecs>

The maximum retry delay between failed attempts to connect to a stream.

attempt_timeout_secs: Option<ConnectAttemptTimeoutSecs>

The timeout for a request made to Nakadi to connect to a stream.

Implementations

impl ConnectConfig

pub fn from_env() -> Result<Self, Error>

Initializes all fields from environment variables prefixed with "NAKADION_"

pub fn from_env_prefixed<T: AsRef<str>>(prefix: T) -> Result<Self, Error>

Initializes all fields from environment variables prefixed with "[prefix]_" The underscore is omitted if prefix is empty

pub fn from_env_type_names() -> Result<Self, Error>

Initializes all fields from environment variables without any prefix

pub fn fill_from_env(&mut self) -> Result<(), Error>

Updates all not yet set fields from environment variables prefixed with "NAKADION_"

pub fn fill_from_env_prefixed<T: AsRef<str>>(
    &mut self,
    prefix: T
) -> Result<(), Error>

Updates all not yet set fields from environment variables prefixed with "[prefix]_" The underscore is omitted if prefix is empty

pub fn fill_from_env_type_names(&mut self) -> Result<(), Error>

Updates all not yet set fields from environment variables without any prefix

pub fn apply_defaults(&mut self)

Fills not set values with default values.

The filled in values are those which would be used if a value was not set.

pub fn stream_parameters<T: Into<StreamParameters>>(self, v: T) -> Self

StreamParameters used to configure the stream consumed from Nakadi

pub fn abort_on_auth_error<T: Into<ConnectAbortOnAuthError>>(self, v: T) -> Self

If set to true auth error will not cause a retry on connect attempts

pub fn abort_on_conflict<T: Into<ConnectAbortOnConflict>>(self, v: T) -> Self

If set to true conflicts (Status 409) will not cause a retry on connect attempts

pub fn abort_connect_on_subscription_not_found<T: Into<ConnectAbortOnSubscriptionNotFound>>(
    self,
    v: T
) -> Self

If true abort the consumer when a subscription does not exist when connection to a stream.

pub fn timeout_secs<T: Into<ConnectTimeout>>(self, v: T) -> Self

The maximum time for until a connection to a stream has to be established.

Default is to retry indefinitely

pub fn max_retry_delay_secs<T: Into<ConnectMaxRetryDelaySecs>>(
    self,
    v: T
) -> Self

The maximum retry delay between failed attempts to connect to a stream.

pub fn attempt_timeout_secs<T: Into<ConnectAttemptTimeoutSecs>>(
    self,
    v: T
) -> Self

The timeout for a request made to Nakadi to connect to a stream.

pub fn configure_stream_parameters<F>(self, f: F) -> Self where
    F: FnMut(StreamParameters) -> StreamParameters, 

Modify the current StreamParameters with a closure.

pub fn try_configure_stream_parameters<F>(self, f: F) -> Result<Self, Error> where
    F: FnMut(StreamParameters) -> Result<StreamParameters, Error>, 

Modify the current StreamParameters with a closure.

Trait Implementations

impl Clone for ConnectConfig

fn clone(&self) -> ConnectConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectConfig

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

Formats the value using the given formatter.

impl Default for ConnectConfig

fn default() -> ConnectConfig

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for ConnectConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for ConnectConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.