Struct Docs 

pub struct Docs {
    pub enabled: bool,
    pub max_size: usize,
    pub build_timeout_seconds: u64,
    pub build_wrapper: Vec<String>,
}

Fields

enabled: bool

Enable documentation hosting

Building docs runs the build scripts and proc macros of every published crate on the Kellnr host. See build_wrapper before enabling this for publishers you do not fully trust.

max_size: usize

Max docs size in MB

build_timeout_seconds: u64

Max duration of a single rustdoc build in seconds (0 = unlimited). Builds that take longer are killed and the crate is skipped.

build_wrapper: Vec<String>

Command prefix (comma-separated) for the rustdoc build process.

Building docs compiles the published crate, which runs its build scripts and proc macros. Kellnr runs every build in a child process with a cleared environment, so no KELLNR_* settings or secrets are passed on. Cargo’s own CARGO_* variables are kept, so a registry token in CARGO_REGISTRIES_<NAME>_TOKEN is visible to build scripts and should belong to a dedicated read-only user. The build still runs as the Kellnr user: it can read every file Kellnr can read (for example the config file or the SQLite database, e.g. via include_str!) and it has network access. Kellnr only publishes the files rustdoc generates, but the build can write such content into the generated docs of the crate. Only enable docs for crates you trust, or set a wrapper that confines the build, e.g. with bubblewrap: ["bwrap", "--ro-bind", "/", "/", "--tmpfs", "<data_dir>", "--bind", "<data_dir>/doc_queue", "<data_dir>/doc_queue", "--bind", "<cargo_home>", "<cargo_home>", "--tmpfs", "/etc/kellnr", "--dev", "/dev", "--proc", "/proc", "--tmpfs", "/tmp", "--unshare-pid", "--die-with-parent", "--"]. The wrapper is followed by the Kellnr binary and its arguments.

Implementations

impl Docs

pub fn max_bytes(&self) -> usize

max_size in bytes.

Trait Implementations

impl Clone for Docs

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for Docs

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for Docs

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

Formats the value using the given formatter.

impl Default for Docs

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Docs

where Docs: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Docs

impl PartialEq for Docs

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Docs

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Docs

impl ToSchema for Docs

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.