Enum nakadion::consumer::StreamDeadPolicy[−][src]

#[non_exhaustive]
pub enum StreamDeadPolicy {
    Never,
    NoFramesFor {
        seconds: u32,
    },
    NoEventsFor {
        seconds: u32,
    },
}

Expand description

Specifies when a stream is considered dead and has to be aborted.

Once a stream is considered dead a reconnect for a new stream will be attempted.

The default is NoFramesFor { seconds: 300 }

FromStr

use nakadion::consumer::StreamDeadPolicy;

let policy = "never".parse::<StreamDeadPolicy>().unwrap();
assert_eq!(policy, StreamDeadPolicy::Never);

let policy = "no_frames_for_seconds 1".parse::<StreamDeadPolicy>().unwrap();
assert_eq!(
    policy,
    StreamDeadPolicy::NoFramesFor { seconds: 1}
);

let policy = "no_events_for_seconds 2".parse::<StreamDeadPolicy>().unwrap();
assert_eq!(
    policy,
    StreamDeadPolicy::NoEventsFor { seconds: 2}
);

JSON is also valid:

use nakadion::consumer::StreamDeadPolicy;

let policy = r#""never""#.parse::<StreamDeadPolicy>().unwrap();
assert_eq!(policy, StreamDeadPolicy::Never);

let policy = r#"{"no_frames_for":{"seconds": 1}}"#.parse::<StreamDeadPolicy>().unwrap();
assert_eq!(
    policy,
    StreamDeadPolicy::NoFramesFor { seconds: 1}
);

let policy = r#"{"no_events_for":{"seconds": 2}}"#.parse::<StreamDeadPolicy>().unwrap();
assert_eq!(
    policy,
    StreamDeadPolicy::NoEventsFor { seconds: 2}
);

Environment variables

Fetching values from the environment uses FromStr for parsing

Variants (Non-exhaustive)

This enum is marked as non-exhaustive

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Never

The stream is never considered dead

NoFramesFor

The stream is considered dead if no frames (lines) have been received from Nakadi for seconds

Fields of NoFramesFor

seconds: u32

NoEventsFor

The stream is considered dead if no events (lines with events) have been received from Nakadi for seconds

Fields of NoEventsFor

seconds: u32

Implementations

[src]

impl StreamDeadPolicy

[src]

pub const ENV_TYPE_NAME: &'static str

The default name of the environment variable for this type. The name of the environment variable is “ STREAM_DEAD_POLICY “

[src]

pub fn try_from_env() -> Result<Option<Self>, Error>

Initialize from the environment. Returns None if the value was not found and fails if the value could not be parsed. The name of the environment variable is “NAKADION_ STREAM_DEAD_POLICY “

[src]

pub fn try_from_env_prefixed<T: Into<String>>(
prefix: T
) -> Result<Option<Self>, Error>

Initialize from the environment. Returns None if the value was not found and fails if the value could not be parsed. The name of the environment variable is “prefix_ STREAM_DEAD_POLICY “ The underscore and prefix will be omitted if prefix is empty.

[src]

pub fn try_from_env_named<T: AsRef<str>>(
var_name: T
) -> Result<Option<Self>, Error>

Initialize from the environment. Returns None if the value was not found and fails if the value could not be parsed. The name of the environment variable is var_name.

[src]

pub fn try_from_env_type_name() -> Result<Option<Self>, Error>

Initialize from the environment. Returns None if the value was not found and fails if the value could not be parsed. The name of the environment variable is “ STREAM_DEAD_POLICY “

[src]

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

Initialize from the environment. Fails if the value was not found or if the value could not be parsed. The name of the environment variable is “NAKADION_ STREAM_DEAD_POLICY “

[src]

pub fn from_env_prefixed<T: Into<String>>(prefix: T) -> Result<Self, Error>

Initialize from the environment. Fails if the value was not found or if the value could not be parsed. The name of the environment variable is “prefix_ STREAM_DEAD_POLICY “ The underscore and prefix will be omitted if prefix is empty.

[src]

pub fn from_env_named<T: AsRef<str>>(var_name: T) -> Result<Self, Error>

Initialize from the environment. Fails if the value was not found or if the value could not be parsed. The name of the environment variable is var_name.

[src]

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

Initialize from the environment. Fails if the value was not found or if the value could not be parsed. The name of the environment variable is “ STREAM_DEAD_POLICY “

[src]

pub fn from_env_opt() -> Option<Self>

Initialize from the environment. Returns None if the value could not be read for any reason. The name of the environment variable is “NAKADION_ STREAM_DEAD_POLICY “

[src]

pub fn from_env_opt_prefixed<T: Into<String>>(prefix: T) -> Option<Self>

Initialize from the environment. Returns None if the value could not be read for any reason. The name of the environment variable is “prefix_ STREAM_DEAD_POLICY “ The underscore and prefix will be omitted if prefix is empty.

[src]

pub fn from_env_opt_named<T: AsRef<str>>(var_name: T) -> Option<Self>

Initialize from the environment. Returns None if the value could not be read for any reason. The name of the environment variable is var_name.

[src]

pub fn from_env_opt_type_name() -> Option<Self>

Initialize from the environment. Returns None if the value could not be read for any reason. The name of the environment variable is “ STREAM_DEAD_POLICY “

[src]