Struct vimwiki_server::Opt

pub struct Opt {
    pub verbose: u8,
    pub quiet: bool,
    pub log_dir: Option<PathBuf>,
    pub mode: Mode,
    pub host: IpAddr,
    pub port: u16,
    pub graphiql: bool,
    pub cache: PathBuf,
    pub config: Option<PathBuf>,
    pub merge: bool,
}

Fields

verbose: u8

Verbose mode (-v, -vv, -vvv, etc.)

quiet: bool

Quiet mode

log_dir: Option<PathBuf>

Specify a directory to store log output as files rather than stdout/stderr

mode: Mode

Mode to run server (http = web; stdin = read input from stdin and reply on stdout)

host: IpAddr

Host/IP address of server in http mode

port: u16

Port of the server in http mode

graphiql: bool

If provided, will include hosting of /graphiql endpoint

cache: PathBuf

Directory where cache information for use with server will be stored

config: Option<PathBuf>

Path to config file for wiki definitions

merge: bool

If specified, will attempt to merge wikis loaded from vim/neovim with wikis defined via a config file if accessible. Wikis from vim/neovim will be first such that their indexes align with those defined in vimscript with the config file wikis being added after

If not specified, then vim/neovim wikis are only loaded if there is no config file or the config file has no wikis defined

Implementations

impl Opt

pub fn load() -> Self

pub fn log_level(&self) -> LevelFilter

The level to use for logging throughout the server

Trait Implementations

impl Debug for Opt

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

Formats the value using the given formatter.

impl StructOpt for Opt

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

Returns clap::App corresponding to the struct.

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

Builds the struct from clap::ArgMatches. It’s guaranteed to succeed if matches originates from an App generated by StructOpt::clap called on the same type, otherwise it must panic.

fn from_args() -> Self

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

fn from_args_safe() -> Result<Self, Error>

Builds the struct from the command line arguments (std::env::args_os). Unlike StructOpt::from_args, returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

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 Opt

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

fn is_subcommand() -> bool

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