Skip to main content

ConfigFile

Struct ConfigFile 

Source
pub struct ConfigFile {
    pub generator: GeneratorSection,
    pub features: FeaturesSection,
    pub http_client: Option<HttpClientSection>,
    pub streaming: Option<StreamingSection>,
    pub server: Option<ServerSection>,
    pub client: Option<ClientSection>,
    pub nullable_overrides: BTreeMap<String, bool>,
    pub extensible_enums: BTreeMap<String, bool>,
    pub type_mappings: BTreeMap<String, String>,
    pub types: TypeMappingConfig,
}
Expand description

Root configuration loaded from TOML file

Fields§

§generator: GeneratorSection§features: FeaturesSection§http_client: Option<HttpClientSection>§streaming: Option<StreamingSection>§server: Option<ServerSection>

Server codegen opt-in. Absent or empty operations list ⇒ no server code emitted. See docs/planning/server-codegen.md.

§client: Option<ClientSection>

Optional HTTP-client operation scope. Absent means all operations.

§nullable_overrides: BTreeMap<String, bool>§extensible_enums: BTreeMap<String, bool>

Force a closed string-enum schema to be rendered as an extensible enum (with a Custom(String) fallback variant). Use when the spec under- declares the enum and the API returns values outside the declared set. Format: "SchemaName" = true. Mirror of nullable_overrides.

§type_mappings: BTreeMap<String, String>§types: TypeMappingConfig

Normalized type-mapping configuration.

TOML deserialization accepts canonical [generator.types] and the temporary top-level [types] compatibility alias. Serialization always writes this value back in the canonical nested location.

Implementations§

Source§

impl ConfigFile

Source

pub fn load(path: &Path) -> Result<Self, GeneratorError>

Load and validate configuration from a TOML file.

Relative spec_path, output_dir, and schema_extensions values are resolved against the directory containing path, independent of the process’s current working directory.

Source

pub fn into_generator_config(self) -> GeneratorConfig

Convert to internal GeneratorConfig

Trait Implementations§

Source§

impl Clone for ConfigFile

Source§

fn clone(&self) -> ConfigFile

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 ConfigFile

Source§

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

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

impl<'de> Deserialize<'de> for ConfigFile

Source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ConfigFile

Source§

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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<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