Skip to main content

HyperConfig

Struct HyperConfig 

Source
pub struct HyperConfig {
    pub data_dir: PathBuf,
    pub storage_path_template: String,
    pub trust_provider: Arc<dyn TrustProvider>,
    pub credential_expiry_warning: Duration,
    pub mailbox_backpressure_threshold: Option<usize>,
}
Expand description

Hyper initialization configuration.

Fields§

§data_dir: PathBuf

Root data directory, corresponds to the namespace template variable {data_dir}

§storage_path_template: String

Storage namespace path template, defaults to {data_dir}/{actr_type}

Available variables:

  • {data_dir} — root data directory
  • {instance_id} — locally unique ID generated and persisted at Hyper startup
  • {hostname} — OS hostname
  • {manufacturer} — Actor manufacturer name
  • {actr_name} — Actor name
  • {version} — Actor version
  • {actr_type} — full three-part type ({manufacturer}/{actr_name}/{version})
  • {realm_id} — Actor’s realm (available at runtime)
  • {env.VAR} — any environment variable
§trust_provider: Arc<dyn TrustProvider>

Pluggable package-signature verifier. Replaces the old TrustMode enum.

Construct via crate::verify::StaticTrust, crate::verify::RegistryTrust, or crate::verify::ChainTrust (or bring your own).

§credential_expiry_warning: Duration

How far in advance of expiry the framework should fire the on_credential_expiring hook.

Default: 5 minutes.

§mailbox_backpressure_threshold: Option<usize>

Queue-length trip point for the on_mailbox_backpressure hook.

When Some(threshold), the hook fires once per incident as soon as the mailbox queued-message count crosses threshold, and re-arms once the queue falls back below. When None, a built-in default of [DEFAULT_MAILBOX_BACKPRESSURE_THRESHOLD] messages is used. The mailbox trait currently exposes status() which reports queued_messages, so the polling-based implementation in lifecycle::node works against any mailbox backend that supports the base trait.

Implementations§

Source§

impl HyperConfig

Source

pub fn new( data_dir: impl AsRef<Path>, trust_provider: Arc<dyn TrustProvider>, ) -> Self

Build a new HyperConfig with the given data_dir and package trust provider.

There is no default provider — you must explicitly decide how packages are authenticated (see crate::verify::StaticTrust / crate::verify::RegistryTrust / crate::verify::ChainTrust).

Source

pub fn with_storage_template(self, template: impl Into<String>) -> Self

Source

pub fn with_trust_provider(self, trust_provider: Arc<dyn TrustProvider>) -> Self

Source

pub fn with_credential_expiry_warning(self, window: Duration) -> Self

Override the credential-expiry warning lead time.

Source

pub fn with_mailbox_backpressure_threshold( self, threshold: Option<usize>, ) -> Self

Set the mailbox backpressure threshold.

See HyperConfig::mailbox_backpressure_threshold for semantics.

Source

pub fn resolved_mailbox_backpressure_threshold(&self) -> usize

Resolve the active mailbox backpressure threshold — explicit override or the built-in [DEFAULT_MAILBOX_BACKPRESSURE_THRESHOLD].

Trait Implementations§

Source§

impl Clone for HyperConfig

Source§

fn clone(&self) -> HyperConfig

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 HyperConfig

Available on non-WebAssembly only.
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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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> 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> MaybeSendSync for T
where T: Send + Sync + ?Sized,

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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