Skip to main content

RedisEndpointConfig

Struct RedisEndpointConfig 

Source
pub struct RedisEndpointConfig {
    pub host: Option<String>,
    pub port: Option<u16>,
    pub command: RedisCommand,
    pub channels: Vec<String>,
    pub key: Option<String>,
    pub timeout: u64,
    pub password: Option<String>,
    pub db: u8,
}
Expand description

Configuration parsed from a Redis URI.

Format: redis://host:port?command=GET&... or redis://?command=GET (no host/port)

§Fields with Global Defaults (Option)

These fields can be set via global defaults in Camel.toml. They are Option<T> to distinguish between “not set by URI” (None) and “explicitly set by URI” (Some(v)). After calling apply_defaults() + resolve_defaults(), all are guaranteed Some.

  • host - Redis server hostname
  • port - Redis server port

§Fields Without Global Defaults

These fields are per-endpoint only and have no global defaults:

  • command - Redis command to execute (default: SET)
  • channels - Channels for pub/sub operations (default: empty)
  • key - Key for operations that require it (default: None)
  • timeout - Timeout in seconds for blocking operations (default: 1)
  • password - Redis password for authentication (default: None)
  • db - Redis database number (default: 0)

Fields§

§host: Option<String>

Redis server hostname. None if not set in URI. Filled by apply_defaults() from global config, then resolve_defaults().

§port: Option<u16>

Redis server port. None if not set in URI. Filled by apply_defaults() from global config, then resolve_defaults().

§command: RedisCommand

Redis command to execute. Default: SET.

§channels: Vec<String>

Channels for pub/sub operations. Default: empty.

§key: Option<String>

Key for operations that require it. Default: None.

§timeout: u64

Timeout in seconds for blocking operations. Default: 1.

§password: Option<String>

Redis password for authentication. Default: None.

§db: u8

Redis database number. Default: 0.

Implementations§

Source§

impl RedisEndpointConfig

Source

pub fn from_uri(uri: &str) -> Result<Self, CamelError>

Source

pub fn apply_defaults(&mut self, defaults: &RedisConfig)

Apply global defaults to any None fields.

This method fills in default values from the provided RedisConfig for fields that are None (not set in URI). It’s intended to be called after parsing a URI when global component defaults should be applied.

Source

pub fn resolve_defaults(&mut self)

Resolve any remaining None fields to hardcoded defaults.

This should be called after apply_defaults() to ensure all fields that can have global defaults are guaranteed to be Some.

Source

pub fn redis_url(&self) -> String

Build the Redis connection URL.

After resolve_defaults(), host and port are guaranteed Some.

Trait Implementations§

Source§

impl Clone for RedisEndpointConfig

Source§

fn clone(&self) -> RedisEndpointConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RedisEndpointConfig

Source§

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

Formats the value using the given formatter. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

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>,

Source§

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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