Struct Config 

pub struct Config {
    pub setup: Option<RawOrImport<Setup>>,
    pub port: u16,
    pub web_client: bool,
    pub game: Game,
    pub integrations: Integrations,
    pub max_submissions: Option<NonZero<u32>>,
    pub languages: RawOrImport<LanguageSet>,
    pub accounts: RawOrImport<Accounts>,
    pub packet: RawOrImport<Packet>,
    pub test_runner: RawOrImport<TestRunner>,
}

Fields

setup: Option<RawOrImport<Setup>>

Configuration for setting up the docker container and starting the server

port: u16

Port on which the server will be hosted

web_client: bool

Whether this competition should host the web client

game: Game

Indicates the mode by which the competition is held.

In points, each team must attempt to score the most points possible

integrations: Integrations

Contains information for all things related to programmability and external integrations in Basalt.

max_submissions: Option<NonZero<u32>>

Maximum number of attempts that a user is allowed to make for a given problem

languages: RawOrImport<LanguageSet>

List of languages available for the server

accounts: RawOrImport<Accounts>

Accounts that will be granted access to the server

packet: RawOrImport<Packet>

The packet for this competition

test_runner: RawOrImport<TestRunner>

Configuration for the test runner

Implementations

impl Config

pub fn from_str( content: impl AsRef<str>, file_name: Option<impl AsRef<str>>, ) -> Result<Self, ConfigReadError>

Read config from a string

• file_name provided for better miette errors

pub fn read<R>( reader: &mut R, file_name: Option<impl AsRef<str>>, ) -> Result<Self, ConfigReadError>

where R: Read,

Read config from a file

• file_name provided for better miette errors

pub fn hash(&self) -> String

Generate a hash string for this config

let hash = format!("Your hash is: {}", config.hash());

pub fn render_pdf(&self, template: Option<String>) -> Result<Vec<u8>>

Render the competition information to a PDF, either using a provided template (written in typst) or the default template

Template

The template currently provides several variables that contain information about the competition.

• #title: str - the title of the competition
• #preamble: content - rendered markdown of the competition
• #problems: array<Dict> - array of problems in the packet

pub fn write_pdf<W>( &self, writer: &mut W, template: Option<String>, ) -> Result<()>

where W: Write,

Note: In the current implementation of typst-pdf, this just renders to a vector and then writes that to the writer.

pub fn render_login_pdf(&self, template: Option<String>) -> Result<Vec<u8>>

Render competition logins to PDF, either using a provided template (written in typst) or the default template

Template

The template currently provides several variables that contain information about the competition.

• #title: str - the title of the competition
• #preamble: content - rendered markdown of the competition
• #problems: array<Dict> - array of problems in the packet

pub fn write_login_pdf<W>( &self, writer: &mut W, template: Option<String>, ) -> Result<()>

where W: Write,

Note: In the current implementation of typst-pdf, this just renders to a vector and then writes that to the writer.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate 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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Config

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Config

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Scorable for Config

fn score( &self, problem_idx: usize, ctx: EvaluationContext, ) -> Result<f64, ScoreError>

impl Serialize for Config

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Config

impl StructuralPartialEq for Config