Enum df_storyteller_sqlite::cli::Commands

[−] Show declaration

enum Commands {
    Guide {},
    Import {
        world: u32,
        file: PathBuf,
        show_unknown: bool,
    },
    Start {
        world: u32,
    },
    List {
        page: u32,
    },
    Export {
        world: u32,
        output: PathBuf,
        format: Option<ExportFormats>,
    },
    Docs {
        output: PathBuf,
    },
    Config {},
    Database {
        postgres: bool,
        db_user: Option<String>,
        db_port: Option<u16>,
        drop_db: bool,
    },
}

[−] Expand description

All available subcommands in DF Storyteller.

Variants

Guide

[−] Expand description

A Guide for setting up DF Storyteller. This is also available on our website.

[−] Show fields

Fields of Guide

Import

[−] Expand description

Parse and save the Legends files

[−] Show fields

Fields of Import

world: u32

Select what world to load from DB

file: PathBuf

Legends Files to process. Give one of the legend files, other files will be found automatically

show_unknown: bool

(TODO) Show a list of unknown tags in files

Start

[−] Expand description

Start API server

[−] Show fields

Fields of Start

world: u32

Select what world to load from DB

List

[−] Expand description

List all the saved world

[−] Show fields

Fields of List

page: u32

View next page of worlds. Current page limit = 20. If the list is to long it will be broken up into pages. This allows you to get the other pages.

Export

[−] Expand description

(TODO) Export a saved world

[−] Show fields

Fields of Export

world: u32

Select what world to load from DB

output: PathBuf

Output the parsed legends to file

format: Option<ExportFormats>

Format of output file. Default is Json

Docs

[−] Expand description

Export OpenAPI JSON file. This file can be used together with other documentation viewers like RapiDoc to view the API documentation.

[−] Show fields

Fields of Docs

output: PathBuf

Path to where to write the openapi.json file, can be a file or directory

Config

[−] Expand description

Create/overwrite persistent settings/config file. If no file is found it will create the default config file. If a file is found it will read the file (if valid) and write it again, this will ensure it is a valid and nicely formatted config file.

[−] Show fields

Fields of Config

Database

[−] Expand description

Setup the database

[−] Show fields

Fields of Database

postgres: bool

Set up a Postgres database

db_user: Option<String>

The username that be used to create new roles By default "postgres" is used

db_port: Option<u16>

The port used for the database connection Default is 5432

drop_db: bool

DANGER: This will DELETE the existing df_storyteller database. This deletes all stored data in the database. Once deleted it will create a new database.

Trait Implementations

impl Debug for Commands[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl StructOpt for Commands[+]

[+] Show hidden undocumented items

fn clap<'a, 'b>() -> App<'a, 'b>[−]

Returns the corresponding clap::App.

fn from_clap(matches: &ArgMatches<'_>) -> Self[−]

Creates the struct from clap::ArgMatches. It cannot fail with a parameter generated by clap by construction.

fn from_args() -> Self[−]

Gets the struct from the command line arguments. Print the error message and quit the program in case of failure.

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, [−]

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, [−]

Gets the struct from any iterator such as a Vec of your making.

impl StructOptInternal for Commands[+]

[+] Show hidden undocumented items

fn augment_clap<'a, 'b>(app: App<'a, 'b>) -> App<'a, 'b>

fn from_subcommand<'a, 'b>(
    sub: (&'b str, Option<&'b ArgMatches<'a>>)
) -> Option<Self>

fn is_subcommand() -> bool