Hide runtime construction helpers from docs

This commit is contained in:
andrussal 2026-03-08 13:35:11 +01:00
parent 7e0cdb54f8
commit d2665bdb71
2 changed files with 4 additions and 0 deletions

View File

@ -24,6 +24,7 @@ pub struct RunContext<E: Application> {
impl<E: Application> RunContext<E> {
/// Builds a run context from prepared deployment/runtime artifacts.
#[must_use]
#[doc(hidden)]
pub fn new(
descriptors: E::Deployment,
node_clients: NodeClients<E>,
@ -48,6 +49,7 @@ impl<E: Application> RunContext<E> {
}
#[must_use]
#[doc(hidden)]
pub fn with_cluster_wait(mut self, cluster_wait: Arc<dyn ClusterWaitHandle<E>>) -> Self {
self.cluster_wait = Some(cluster_wait);
self
@ -137,6 +139,7 @@ impl<E: Application> Drop for RunHandle<E> {
impl<E: Application> RunHandle<E> {
#[must_use]
/// Build a handle from owned context and optional cleanup guard.
#[doc(hidden)]
pub fn new(context: RunContext<E>, cleanup_guard: Option<Box<dyn CleanupGuard>>) -> Self {
Self {
run_context: Arc::new(context),

View File

@ -36,6 +36,7 @@ impl<E: Application> Drop for Runner<E> {
impl<E: Application> Runner<E> {
/// Construct a runner from the run context and optional cleanup guard.
#[must_use]
#[doc(hidden)]
pub fn new(context: RunContext<E>, cleanup_guard: Option<Box<dyn CleanupGuard>>) -> Self {
Self {
context: Arc::new(context),