Struct SchemaEntry 

pub struct SchemaEntry { /* private fields */ }

Schema definition for a single config key.

Implementations

impl SchemaEntry

pub fn string() -> Self

Starts a schema entry for string values.

Examples

use osp_cli::config::{SchemaEntry, SchemaValueType};

let entry = SchemaEntry::string().required();
assert_eq!(entry.value_type(), SchemaValueType::String);
assert!(entry.runtime_visible());

pub fn boolean() -> Self

Starts a schema entry for boolean values.

pub fn integer() -> Self

Starts a schema entry for integer values.

pub fn float() -> Self

Starts a schema entry for floating-point values.

pub fn string_list() -> Self

Starts a schema entry for lists of strings.

pub fn required(self) -> Self

Marks the key as required in the resolved runtime view.

pub fn read_only(self) -> Self

Marks the key as read-only for user-provided config sources.

pub fn with_doc(self, doc: &'static str) -> Self

Attaches a human-readable description to the key.

pub fn bootstrap_only( self, phase: BootstrapPhase, scope_rule: BootstrapScopeRule, ) -> Self

Marks the key as bootstrap-only with the given phase and scope rule.

pub fn with_bootstrap_value_rule(self, rule: BootstrapValueRule) -> Self

Adds a bootstrap-only value validation rule.

pub fn with_allowed_values<I, S>(self, values: I) -> Self

where I: IntoIterator<Item = S>, S: AsRef<str>,

Restricts accepted values using a case-insensitive allow-list.

pub fn value_type(&self) -> SchemaValueType

Returns the declared schema type for the key.

pub fn allowed_values(&self) -> Option<&[String]>

Returns the normalized allow-list, if the key is enumerated.

pub fn doc(&self) -> Option<&'static str>

Returns the human-readable description for the key, if one exists.

pub fn runtime_visible(&self) -> bool

Returns whether the key is visible in resolved runtime config.

pub fn writable(&self) -> bool

Returns whether the key can be written by user-controlled sources.

Trait Implementations

impl Clone for SchemaEntry

fn clone(&self) -> SchemaEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaEntry

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

Formats the value using the given formatter.