Skip to main content

ChainConfigRegistry

Struct ChainConfigRegistry 

Source
pub struct ChainConfigRegistry { /* private fields */ }
Expand description

Resolves the full configuration of custom chains by name.

Built-in chains are resolved without this registry; it only holds user-defined chains loaded from a YAML source. Build it explicitly via ChainConfigRegistry::from_configs, ChainConfigRegistry::from_yaml_file, or ChainConfigRegistry::load_default, then install it as the process-wide registry with init_chain_registry.

Implementations§

Source§

impl ChainConfigRegistry

Source

pub fn empty() -> Self

An empty registry — only built-in chains will resolve.

Source

pub fn from_configs( configs: impl IntoIterator<Item = CustomChainConfig>, ) -> Result<Self, ChainConfigError>

Builds a registry from custom chain configs, keyed by chain name. Rejects duplicate names with ChainConfigError::DuplicateChain rather than silently overriding, so an ambiguous config fails loudly at construction.

Source

pub fn load_default() -> Result<Self, ChainConfigError>

Reads custom chain configs from the path in TYCHO_CHAINS_CONFIG.

Returns an empty registry when the env var is unset, so runs on built-in chains need no config. When it is set, the file is loaded as-is: a missing, unreadable, or malformed file is an error (the operator asked for a config, so a broken one is a mistake, not “no custom chains”), leaving the caller to decide how to react. Install the result with init_chain_registry to make it the process-wide registry.

Source

pub fn load_default_or_empty() -> Self

Like load_default but never fails: a broken TYCHO_CHAINS_CONFIG (missing, unreadable, or malformed file) is logged and degrades to an empty registry rather than aborting. Used by chain_registry to lazily initialise the process-wide registry, so a consumer only needs to set TYCHO_CHAINS_CONFIG — no explicit init call. Call load_default directly when you need to react to the error.

Source

pub fn from_yaml_file(path: &str) -> Result<Self, ChainConfigError>

Parses a registry from a YAML file with a top-level chains: list.

Source

pub fn from_yaml_str(contents: &str) -> Result<Self, ChainConfigError>

Parses a registry from a YAML string with a top-level chains: list.

Source

pub fn get(&self, name: &str) -> Option<&CustomChainConfig>

Returns the config for a custom chain by name, if registered.

Source

pub fn contains(&self, name: &str) -> bool

Whether a custom chain with this name is registered.

Trait Implementations§

Source§

impl Clone for ChainConfigRegistry

Source§

fn clone(&self) -> ChainConfigRegistry

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 ChainConfigRegistry

Source§

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

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

impl Default for ChainConfigRegistry

Source§

fn default() -> ChainConfigRegistry

Returns the “default value” for a type. 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> 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> 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