Struct Config

pub struct Config {

    pub port: u16,
    pub name: String,
    pub description: String,
    pub static_dir: PathBufD,
    pub media_dir: PathBufD,
    pub captcha: HCaptchaConfig,
    pub client: ClientConfig,
    pub real_ip_header: Option<String>,
    pub registration_enabled: bool,
    pub host: String,
    pub snowflake_server_id: usize,
    pub blocked_hosts: Vec<String>,
    pub tiers: Tiers,
    pub alert: String,
}

Configuration file

Fields

port: u16

The port to serve the server on

name: String

The name of the site

description: String

The description of the site

static_dir: PathBufD

The location of the static directory, should not be supplied manually as it will be overwritten with ./.config/static

media_dir: PathBufD

The location of media uploads on the file system

captcha: HCaptchaConfig

HCaptcha configuration

client: ClientConfig

Client configuration

real_ip_header: Option<String>

The name of the header used for reading user IP address

registration_enabled: bool

If new profile registration is enabled

host: String

The origin of the public server (ex: “https://rainbeam.net”)

Used in embeds and links.

snowflake_server_id: usize

The server ID for ID generation

blocked_hosts: Vec<String>

A list of image hosts that are blocked

tiers: Tiers

Tiered benefits

alert: String

A global site announcement shown at the top of the page

Implementations

impl Config

pub fn read(contents: String) -> Config

Read configuration file into Config

pub fn get_config() -> Config

Pull configuration file

pub fn update_config(contents: Config) -> Result<(), Error>

Update configuration file

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

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.

impl TS for Config

const DOCS: Option<&'static str> = _

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

type WithoutGenerics = Config

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Config: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<&'static Path>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Config: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use [TS::export_all].

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use [TS::export].

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use [TS::export].

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.