Skip to main content

ServerCli

Struct ServerCli 

Source
pub struct ServerCli {
Show 17 fields pub config: Option<PathBuf>, pub environment: Option<String>, pub profile: Option<String>, pub env_prefix: Option<String>, pub mode: Option<RuntimeMode>, pub web_platform: bool, pub no_web_platform: bool, pub observability: bool, pub no_observability: bool, pub max_body_bytes: Option<usize>, pub request_timeout_ms: Option<u64>, pub rate_limit_capacity: Option<usize>, pub rate_limit_refill_tokens: Option<usize>, pub rate_limit_refill_seconds: Option<u64>, pub id_generator: Option<IdGeneratorKind>, pub print_startup_plan: bool, pub dry_run: bool,
}
Expand description

First-party CLI bootstrap for Vantus applications.

This layer is intentionally runtime-focused. It controls configuration selection, module toggles, runtime limits, and startup behavior. Cargo build profiles remain a build-time concern:

  • use cargo run for debug/dev builds
  • use cargo run --release for optimized release builds

Fields§

§config: Option<PathBuf>

Base configuration file to load instead of auto-discovery.

§environment: Option<String>

Overrides the runtime environment name.

§profile: Option<String>

Overrides the active profile used for profile-specific config files.

§env_prefix: Option<String>

Overrides the environment variable prefix used for config loading.

§mode: Option<RuntimeMode>

Applies runtime defaults for development or production behavior.

§web_platform: bool

Enables the built-in web platform module.

§no_web_platform: bool

Disables the built-in web platform module.

§observability: bool

Enables the first-party observability module.

§no_observability: bool

Disables the first-party observability module.

§max_body_bytes: Option<usize>

Overrides the maximum accepted request body size in bytes.

§request_timeout_ms: Option<u64>

Overrides the outer request timeout in milliseconds.

§rate_limit_capacity: Option<usize>

Token bucket capacity for the global rate limiter.

§rate_limit_refill_tokens: Option<usize>

Number of tokens restored per refill interval.

§rate_limit_refill_seconds: Option<u64>

Rate-limiter refill interval in seconds.

§id_generator: Option<IdGeneratorKind>

Chooses the shared request-ID generator implementation.

§print_startup_plan: bool

Prints the resolved startup plan before booting.

§dry_run: bool

Prints the startup plan and exits without starting the server.

Implementations§

Source§

impl ServerCli

Source

pub fn apply_to_builder( &self, builder: &mut HostBuilder, defaults: CliFeatureDefaults, ) -> Result<(), CliError>

Applies CLI-selected defaults, module toggles, and runtime limits.

Source

pub fn effective_mode(&self) -> RuntimeMode

Returns the resolved runtime mode, defaulting to development.

Source

pub fn id_generator_kind(&self) -> IdGeneratorKind

Returns the resolved ID generator choice, defaulting to UUIDs.

Source

pub fn web_platform_enabled(&self, default: bool) -> bool

Returns whether the built-in web platform module should be installed.

Source

pub fn observability_enabled(&self, default: bool) -> bool

Returns whether the first-party observability module should be installed.

Source

pub fn startup_plan( &self, defaults: CliFeatureDefaults, ) -> Result<String, CliError>

Renders a human-readable startup plan suitable for --dry-run.

Trait Implementations§

Source§

impl Args for ServerCli

Source§

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments
Source§

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut Read more
Source§

impl Clone for ServerCli

Source§

fn clone(&self) -> ServerCli

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl CommandFactory for ServerCli

Source§

fn command<'b>() -> Command

Build a Command that can instantiate Self. Read more
Source§

fn command_for_update<'b>() -> Command

Build a Command that can update self. Read more
Source§

impl Debug for ServerCli

Source§

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

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

impl FromArgMatches for ServerCli

Source§

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

impl Parser for ServerCli

Source§

fn parse() -> Self

Parse from std::env::args_os(), exit on error.
Source§

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.
Source§

fn parse_from<I, T>(itr: I) -> Self
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.
Source§

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.
Source§

fn update_from<I, T>(&mut self, itr: I)
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error. Read more
Source§

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

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> 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<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