Skip to main content

EntropyConfig

Struct EntropyConfig 

Source
pub struct EntropyConfig {
    pub key_file: PathBuf,
    pub iv_file: PathBuf,
    pub listen_addr: SocketAddr,
    pub send_addr: Option<SocketAddr>,
    pub peer_endpoint: SocketAddr,
    pub buffer_size: usize,
    pub header_size: usize,
    pub encrypt: bool,
}
Expand description

Operator-facing configuration for the entropy worker.

§Examples

use std::path::PathBuf;
use dynomite::entropy::EntropyConfig;
let cfg = EntropyConfig {
    key_file: PathBuf::from("conf/recon_key.pem"),
    iv_file: PathBuf::from("conf/recon_iv.pem"),
    listen_addr: "127.0.0.1:8105".parse().unwrap(),
    send_addr: None,
    peer_endpoint: "127.0.0.1:8105".parse().unwrap(),
    buffer_size: 16 * 1024,
    header_size: 1024,
    encrypt: true,
};
assert_eq!(cfg.buffer_size, 16 * 1024);

Fields§

§key_file: PathBuf

On-disk path to the AES-128 key file.

§iv_file: PathBuf

On-disk path to the AES-128-CBC IV file.

§listen_addr: SocketAddr

Address the EntropyReceiver binds to.

§send_addr: Option<SocketAddr>

Optional local bind address for the EntropySender. When None the kernel assigns an ephemeral port on the wildcard address.

§peer_endpoint: SocketAddr

Address the EntropySender dials.

§buffer_size: usize

Plaintext chunk size (bytes). Must be a multiple of 16 when encryption is enabled and must not exceed MAX_BUFFER_SIZE.

§header_size: usize

Snapshot header size (bytes). Must not exceed MAX_HEADER_SIZE.

§encrypt: bool

Whether per-chunk payloads are AES-128-CBC encrypted.

Implementations§

Source§

impl EntropyConfig

Source

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

Validate the cross-field invariants the protocol demands.

§Errors

EntropyError::Config when any invariant is violated.

§Examples
use std::path::PathBuf;
use dynomite::entropy::EntropyConfig;
let mut cfg = EntropyConfig {
    key_file: PathBuf::from("k"),
    iv_file: PathBuf::from("v"),
    listen_addr: "127.0.0.1:0".parse().unwrap(),
    send_addr: None,
    peer_endpoint: "127.0.0.1:0".parse().unwrap(),
    buffer_size: 32,
    header_size: 64,
    encrypt: true,
};
assert!(cfg.validate().is_ok());
cfg.buffer_size = 0;
assert!(cfg.validate().is_err());

Trait Implementations§

Source§

impl Clone for EntropyConfig

Source§

fn clone(&self) -> EntropyConfig

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 EntropyConfig

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,