Skip to main content

Config

Struct Config 

Source
pub struct Config {
Show 17 fields pub root: PathBuf, pub source: Option<PathBuf>, pub app: AppConfig, pub api: ApiConfig, pub server: ServerConfig, pub build: BuildConfig, pub assets: AssetsConfig, pub rendering: RenderingConfig, pub images: ImagesConfig, pub security: SecurityConfig, pub env: EnvConfig, pub dev: DevConfig, pub logging: LoggingConfig, pub redirects: Vec<RedirectRule>, pub headers: Vec<HeaderRule>, pub plugins: BTreeMap<String, Value>, pub tailwind: TailwindConfig,
}

Fields§

§root: PathBuf

Project root (directory containing the config file). Not read from the file.

§source: Option<PathBuf>

The config file that was loaded, if any.

§app: AppConfig§api: ApiConfig§server: ServerConfig§build: BuildConfig§assets: AssetsConfig§rendering: RenderingConfig§images: ImagesConfig§security: SecurityConfig§env: EnvConfig§dev: DevConfig§logging: LoggingConfig§redirects: Vec<RedirectRule>§headers: Vec<HeaderRule>§plugins: BTreeMap<String, Value>

Free-form plugin configuration: [plugins.my-plugin].

§tailwind: TailwindConfig

Tailwind CSS: [tailwind].

Implementations§

Source§

impl Config

Source

pub fn discover(start: impl AsRef<Path>) -> Result<Config, ConfigError>

Discover and load the configuration starting at start.

Source

pub fn discover_with( start: impl AsRef<Path>, toml: Option<fn(&str) -> Result<Config, String>>, ) -> Result<Config, ConfigError>

Config::discover with an optional TOML parser. Without one, next-rust.toml files are reported as an error and only JSON configuration can be read.

Source

pub fn load(path: impl AsRef<Path>) -> Result<Config, ConfigError>

Load a specific file (.toml or .json).

Source

pub fn load_with( path: impl AsRef<Path>, toml: Option<fn(&str) -> Result<Config, String>>, ) -> Result<Config, ConfigError>

Config::load with an optional TOML parser (see TomlParser).

Source

pub fn from_toml_str(text: &str) -> Result<Config, String>

Source

pub fn from_json_str(text: &str) -> Result<Config, String>

Source

pub fn apply_env_overrides(&mut self)

PORT and HOST (conventional on container platforms) override the file.

Source

pub fn resolve(&self, path: impl AsRef<Path>) -> PathBuf

Resolve a path from the configuration against the project root.

Source

pub fn app_dir(&self) -> PathBuf

Source

pub fn public_dir(&self) -> PathBuf

Source

pub fn api_dir(&self) -> Option<PathBuf>

Source

pub fn output_dir(&self) -> PathBuf

Source

pub fn validate(&self) -> Vec<Diagnostic>

Validate paths and values; returns human friendly diagnostics.

Source

pub fn tailwind_diagnostics(&self) -> Vec<Diagnostic>

Problems with the Tailwind setup that stop the CSS from compiling (NR0008: a listed stylesheet is not a file). Part of Config::validate; the build also checks them, since the engine’s own error is unclear.

Source

pub fn socket_addr_string(&self) -> String

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

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 Config

Source§

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

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

impl Default for Config

Source§

fn default() -> Config

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Config
where Config: Default,

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<Config, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

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

impl PartialEq for Config

Source§

fn eq(&self, other: &Config) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for Config

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Config

Auto Trait Implementations§

§

impl Forget for Config

§

impl Freeze for Config

§

impl Move for Config

§

impl RefUnwindSafe for Config

§

impl Send for Config

§

impl Sync for Config

§

impl Unpin for Config

§

impl UnsafeUnpin for Config

§

impl UnwindSafe for Config

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<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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> Same for T

Source§

type Output = T

Should always be Self
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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.