Struct GenericStartup 

pub struct GenericStartup {
    pub options: StartupOptions,
    pub mount_paths: Vec<String>,
    pub registrant: Option<Arc<ConfigurationRegistrant>>,
    pub job_registry: JobRegistry,
    pub gateway: Option<Arc<GatewayConnect>>,
    pub redis: Option<RedisStorage>,
    pub server_addr: Option<SocketAddr>,
    pub socket_addr: Option<SocketAddr>,
    pub consumer_names: Vec<String>,
    /* private fields */
}

Assembled service state produced by GenericStartup::bootstrap or manual init.

Holds the startup options, mounted route registrant, background job registry, gateway connection, cache handle, bound addresses, recorded consumer names, and whether OpenAPI specs were built. Pass &GenericStartup to registrars so they can build controllers and consumers from this state.

Fields

options: StartupOptions

The options this instance was created with.

mount_paths: Vec<String>

URL path prefixes the service handles; also used for docs base and gateway registration.

registrant: Option<Arc<ConfigurationRegistrant>>

HTTP router holder, set by GenericStartup::init. Required before mounting or serving.

job_registry: JobRegistry

Background job registry. Add jobs with GenericStartup::add_job, run with GenericStartup::run_jobs.

gateway: Option<Arc<GatewayConnect>>

Gateway connection, set during GenericStartup::bootstrap when registration succeeds.

redis: Option<RedisStorage>

Redis cache handle, set during GenericStartup::init when Redis is reachable.

server_addr: Option<SocketAddr>

HTTP listen address derived from the configured server port.

socket_addr: Option<SocketAddr>

Socket listen address derived from the configured socket port.

consumer_names: Vec<String>

Queue names recorded from ConsumerRegistrar during bootstrap.

Implementations

impl GenericStartup

pub fn new(options: StartupOptions) -> Self

Creates an empty startup with the given options and no mounted state.

pub fn with_mount_paths(self, paths: Vec<String>) -> Self

Sets the URL path prefixes this service handles.

pub async fn init(&mut self) -> Result<()>

Performs global init: loads the environment, sets up tracing, resolves the server and socket addresses, creates the route registrant, binds the docs base to mount_paths, and connects to Redis on a best-effort basis.

Returns an error if the environment is invalid or an address fails to parse. Redis failure only logs a warning and leaves GenericStartup::redis as None.

pub async fn bootstrap( options: StartupOptions, mount_paths: Vec<String>, static_registrar: Option<Arc<dyn StaticRegistrar>>, controller_registrar: Option<Arc<dyn ControllerRegistrar>>, consumer_registrar: Option<Arc<dyn ConsumerRegistrar>>, ) -> Result<Self>

Runs full startup: global init, static registration, gateway registration, controller mounting with OpenAPI spec building, and consumer recording.

options selects which subsystems run; mount_paths sets the handled URL prefixes. Each registrar is optional: pass None for anything the caller wires manually via the exposed GenericStartup fields. An empty mount_paths skips gateway registration; gateway failure is logged and does not fail bootstrap.

let startup = GenericStartup::bootstrap(opts, mount_paths, None, Some(controllers), None).await?;

pub async fn mount_controller<C: RouteController + 'static>( &self, c: C, ) -> Result<()>

Mounts a controller’s routes onto the router. Errors if GenericStartup::init or GenericStartup::bootstrap has not run.

pub async fn mount_controller_boxed( &self, c: Box<dyn RouteController>, ) -> Result<()>

Mounts a boxed trait-object controller. Used for controllers built by ControllerRegistrar. Errors if not initialised.

pub async fn serve(&self) -> Result<SocketAddr>

Starts the HTTP server in the background and returns the bound address. Errors if not initialised.

pub async fn shutdown(&mut self) -> Result<()>

Stops background jobs and deregisters from the gateway. Failures are logged as warnings; shutdown itself succeeds.

pub fn job_registry(&mut self) -> &mut JobRegistry

Returns the mutable job registry for manual wiring.

pub fn add_job<J: ServiceJob + 'static>(&mut self, job: J)

Adds a job to the registry. Jobs start only when GenericStartup::run_jobs is called.

pub async fn run_jobs(&mut self) -> Result<()>

Starts all registered jobs. No-ops with a log when enable_jobs is false or no jobs are registered.

pub async fn start_jobs(&mut self) -> Result<()>

Alias for GenericStartup::run_jobs.

pub async fn stop_jobs(&mut self) -> Result<()>

Stops all running jobs.

pub fn registrant(&self) -> Option<Arc<ConfigurationRegistrant>>

Returns the route registrant, if initialised.

pub fn gateway_client(&self) -> Option<Arc<GatewayConnect>>

Returns the gateway connection, if registration succeeded.

pub fn redis_client(&self) -> Option<RedisStorage>

Returns the Redis cache handle, if Redis was reachable at init.

pub fn server_addr(&self) -> Option<SocketAddr>

Returns the resolved HTTP listen address, if initialised.

pub fn socket_addr(&self) -> Option<SocketAddr>

Returns the resolved socket listen address, if initialised.

pub fn router_handle(&self) -> Option<Arc<RwLock<Router>>>

Returns the shared router handle, if initialised.

pub fn is_production(&self) -> bool

Reports whether the loaded environment is production. Returns false when the environment is not provisioned.

pub fn docs_built(&self) -> bool

Reports whether OpenAPI specs were built during bootstrap.

pub fn server_urls(&self) -> Vec<String>

Returns the localhost server URLs for the configured server port (defaults to 8080 when unprovisioned).