Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub content_dir: PathBuf,
    pub output_dir: PathBuf,
    pub storage: Option<StorageConfig>,
    pub published: Option<bool>,
    pub theme: Option<ThemeId>,
    pub internal_link_target: Option<String>,
    pub preamble: Option<String>,
    pub platforms: HashMap<String, PlatformConfig>,
}
Expand description

Main configuration structure

Fields§

§content_dir: PathBuf§output_dir: PathBuf§storage: Option<StorageConfig>

Global storage configuration for External asset strategy Per [[RFC-0004:C-STORAGE-CONFIG]]

§published: Option<bool>

Global default for published state (layer 4 per [[RFC-0005:C-RESOLUTION-ORDER]])

§theme: Option<ThemeId>

Global default theme (layer 4 in theme resolution chain)

§internal_link_target: Option<String>

Global default platform for internal link resolution in copypaste adapters. Per-post internal_link_target in meta.toml overrides this. If neither is set, auto-selects first published platform alphabetically.

§preamble: Option<String>

Global Typst render preamble override (layer 4 per [[RFC-0005:C-RESOLUTION-ORDER]]).

§platforms: HashMap<String, PlatformConfig>

Implementations§

Source§

impl Config

Source

pub fn load(path: &Path) -> Result<ConfigLoadResult>

Load configuration from a file.

Returns ConfigLoadResult::DefaultsUsed if the file does not exist, allowing the caller to decide how to handle the warning.

Source

pub fn load_or_default(path: &Path) -> Result<Config>

Load configuration, returning defaults if file not found.

This is a convenience method that discards the “defaults used” information. Use load() if you need to know whether defaults were used.

Source

pub fn get_platform(&self, id: &str) -> Option<&PlatformConfig>

Get platform configuration by ID

Source

pub fn default_platforms(&self) -> Vec<(&str, &PlatformConfig)>

Get platforms that should be targeted by default (present and not disabled).

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

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 Debug for Config

Source§

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

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

impl Default for Config

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for Config

Source§

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

Deserialize this value from the given Serde deserializer. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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 = 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,