Skip to main content

ConfRiak

Struct ConfRiak 

Source
pub struct ConfRiak {
    pub pbc_listen: Option<String>,
    pub http_listen: Option<String>,
    pub aae_enabled: Option<bool>,
    pub aae_full_sweep_interval_seconds: Option<u64>,
    pub aae_segment_interval_seconds: Option<u64>,
    pub tls_cert: Option<PathBuf>,
    pub tls_key: Option<PathBuf>,
    pub tls_ca: Option<PathBuf>,
    pub wasm_modules: Option<Vec<ConfRiakWasmModule>>,
}
Expand description

Optional Riak-mode listener / AAE knobs.

Every field is optional. The PBC and HTTP listeners are independent: setting one without the other is supported. When aae_enabled is true the active anti-entropy scheduler is spawned; the cadence knobs default to the values shipped by dyniak::aae::config.

§Examples

use dynomite::conf::ConfRiak;
let r = ConfRiak {
    pbc_listen: Some("127.0.0.1:8087".into()),
    http_listen: Some("127.0.0.1:8098".into()),
    aae_enabled: Some(false),
    aae_full_sweep_interval_seconds: None,
    aae_segment_interval_seconds: None,
    tls_cert: None,
    tls_key: None,
    tls_ca: None,
    wasm_modules: None,
};
assert!(r.validate().is_ok());

Fields§

§pbc_listen: Option<String>

Address the Riak Protocol Buffers Client listener binds to (host:port). When unset, the PBC listener is not started.

§http_listen: Option<String>

Address the Riak HTTP gateway listener binds to (host:port). When unset, the HTTP gateway is not started.

§aae_enabled: Option<bool>

When true, the Riak active anti-entropy scheduler is spawned alongside the listeners. Default: false.

§aae_full_sweep_interval_seconds: Option<u64>

Override for the AAE full-sweep cadence, in seconds. When unset, dyniak::aae::config::DEFAULT_FULL_SWEEP_SECONDS (24h) is used.

§aae_segment_interval_seconds: Option<u64>

Override for the AAE per-segment exchange cadence, in seconds. When unset, dyniak::aae::config::DEFAULT_SEGMENT_SECONDS (60s) is used.

§tls_cert: Option<PathBuf>

tls_cert: - PEM certificate path for the Riak PBC and HTTP listeners. When both tls_cert and tls_key are set, both Riak listeners terminate TLS; when both are absent, both listeners run in plaintext (the historical behaviour). Setting one without the other is rejected at validation time.

§tls_key: Option<PathBuf>

tls_key: - PEM private-key path matching Self::tls_cert.

§tls_ca: Option<PathBuf>

tls_ca: - optional PEM CA bundle for mutual TLS on the Riak listeners. When set, every inbound client must present a certificate signed by a CA from this bundle. When unset, the listeners terminate TLS without requesting a client certificate.

§wasm_modules: Option<Vec<ConfRiakWasmModule>>

wasm_modules: - optional list of Wasm modules to register with the MapReduce executor at startup. Each entry pairs a logical id with the on-disk path of a Wasm binary (.wasm) or WAT text (.wat) file. When dynomited is built with the wasm Cargo feature it loads every entry through [dyniak::mapreduce::wasm::load_modules_from_config] and exposes the resulting store on the executor; without the feature the field is parsed and validated but the loader is never called (the runtime returns the typed WasmNotImplemented error if a Phase::WasmModule is submitted).

Validation: every id must be unique and every path must point at an existing file at validation time.

Implementations§

Source§

impl ConfRiak

Source

pub fn validate(&self) -> Result<(), ConfError>

Validate the cross-field invariants of the Riak block.

§Errors

Returns a ConfError::BadServer when an address fails to parse as a host:port socket address, when an AAE cadence is zero, or when aae_segment_interval_seconds exceeds aae_full_sweep_interval_seconds.

§Examples
use dynomite::conf::ConfRiak;
let r = ConfRiak {
    pbc_listen: Some("not-a-socket-addr".into()),
    ..ConfRiak::default()
};
assert!(r.validate().is_err());

Trait Implementations§

Source§

impl Clone for ConfRiak

Source§

fn clone(&self) -> ConfRiak

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ConfRiak

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ConfRiak

Source§

fn default() -> ConfRiak

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ConfRiak

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ConfRiak

Source§

fn eq(&self, other: &ConfRiak) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for ConfRiak

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for ConfRiak

Source§

impl StructuralPartialEq for ConfRiak

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> Same for T

Source§

type Output = T

Should always be Self
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
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,