README
- ::findConfig::find
- ::find_allConfig::find_all
- ::arg0Directive::arg0
- ::childDirective::child
- ::is_blockDirective::is_block
- ::is_commentDirective::is_comment
- ::is_includeDirective::is_include
- ::messageNgxError::message
T
Tok
T
TokKind
V
build_config
V
collect_names
V
config_json
V
config_ok
V
count_directives
V
dir_block
V
dir_comment
V
dir_simple
V
dump_conf
V
empty_config
V
first_server_name
V
has_ssl
V
includes_of
V
known_core_directive
V
library_name
V
line_msg
V
listen_addrs
V
location_paths
V
locations_of
V
ngx_access_log
V
ngx_add_header
V
ngx_allow
V
ngx_client_max_body_size
V
ngx_deny
V
ngx_error_log
V
ngx_events
V
ngx_gzip
V
ngx_http
V
ngx_if
V
ngx_include
V
ngx_index
V
ngx_keepalive_timeout
V
ngx_listen
V
ngx_location
V
ngx_location_mod
V
ngx_pid
V
ngx_proxy_pass
V
ngx_return_code
V
ngx_return_url
V
ngx_rewrite
V
ngx_root
V
ngx_sendfile
V
ngx_server
V
ngx_server_name
V
ngx_set
V
ngx_try_files
V
ngx_upstream
V
ngx_upstream_server
V
ngx_worker_connections
V
ngx_worker_processes
V
parse_and_validate
V
parse_conf
V
parse_conf_named
V
parse_dump
V
payload_json
V
payload_text
V
proxy_backends
V
rewrite_rules
V
roundtrip
V
servers_of
V
supported_blocks
V
syntax_profile
V
unwrap_ngx
V
upstream_peers
V
validate_core

moonnginx

nginx.conf directive-tree codec for MoonBit

nginx

nginx.conf

crossplane

config

parser

Download zip

Author

LuoYunxin1

Version

0.1.0

License

Apache-2.0

Repository

github.com/LuoYunxin1/moonnginx

Last updated

18 hours ago

Downloads

#MoonNginx

MoonBit codec for nginx.conf: lex, parse to a directive tree, dump, build, and check OSS core-module context/arity.

Behavioral reference: nginxinc/nginx-go-crossplane (Apache-2.0). Go sources are not copied.

#Install

moon add LuoYunxin1/moonnginx

Until the package is published, depend on this repository as a local module.

#Parse and dump

let cfg = unwrap_ngx(parse_conf("worker_processes 4;\n"))
let text = dump_conf(cfg)

#Three runnable scenarios

moon run cmd/main --target wasm-gc

PARSE — upstream + location + proxy_pass
BUILD — listen 8080 and root /var/www
VALIDATE — listen inside location is rejected

#Verify

moon check --target wasm-gc --deny-warn
moon test --target wasm-gc

#Boundary

Does not start nginx, terminate TLS, execute Lua/OpenResty, follow include on disk, or speak HAProxy PROXY protocol.

#License

Apache-2.0

Config

source

pub(all) struct Config {
  file : String
  parsed : Array[Directive]
  status : String
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Config::find

source

fn Config::find(self : Config, name : String) -> Array[Directive]

Config::find_all

source

fn Config::find_all(self : Config, name : String) -> Array[Directive]

Directive

source

pub(all) struct Directive {
  name : String
  line : Int
  args : Array[String]
  quoted : Array[Bool]
  children : Array[Directive]
  has_block : Bool
  comment : String?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

One nginx statement: simple, block, or comment.

Directive::arg0

source

fn Directive::arg0(self : Directive) -> String?

Directive::child

source

fn Directive::child(self : Directive, name : String) -> Array[Directive]

Directive::is_block

source

fn Directive::is_block(self : Directive) -> Bool

Directive::is_comment

source

fn Directive::is_comment(self : Directive) -> Bool

Directive::is_include

source

fn Directive::is_include(self : Directive) -> Bool

NgxError

source

pub(all) enum NgxError {
  Syntax(String)
  Unexpected(String)
  Unterminated(String)
  Constraint(String)
  NotImplemented(String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

nginx.conf codec errors.

NgxError::message

source

fn NgxError::message(self : NgxError) -> String

Tok

source

pub(all) struct Tok {
  kind : TokKind
  value : String
  line : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

TokKind

source

pub(all) enum TokKind {
  Word
  Quoted
  LBrace
  RBrace
  Semi
  Comment
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

build_config

source

fn build_config(dirs : Array[Directive]) -> Config

collect_names

source

fn collect_names(cfg : Config) -> Array[String]

config_json

source

fn config_json(cfg : Config) -> Json

config_ok

source

fn config_ok(file : String, parsed : Array[Directive]) -> Config

count_directives

source

fn count_directives(cfg : Config) -> Int

dir_block

source

fn dir_block(name : String, args : Array[String], children : Array[Directive], line : Int) -> Directive

dir_comment

source

fn dir_comment(text : String, line : Int) -> Directive

dir_simple

source

fn dir_simple(name : String, args : Array[String], line : Int) -> Directive

dump_conf

source

fn dump_conf(cfg : Config) -> String

empty_config

source

fn empty_config(file : String) -> Config

first_server_name

source

fn first_server_name(server : Directive) -> String?

has_ssl

source

fn has_ssl(server : Directive) -> Bool

includes_of

source

fn includes_of(cfg : Config) -> Array[String]

known_core_directive

source

fn known_core_directive(name : String) -> Bool

library_name

source

fn library_name() -> String

line_msg

source

fn line_msg(line : Int, msg : String) -> String

listen_addrs

source

fn listen_addrs(server : Directive) -> Array[String]

location_paths

source

fn location_paths(server : Directive) -> Array[String]

locations_of

source

fn locations_of(server : Directive) -> Array[Directive]

ngx_access_log

source

fn ngx_access_log(path : String) -> Directive

ngx_add_header

source

fn ngx_add_header(name : String, value : String) -> Directive

ngx_allow

source

fn ngx_allow(spec : String) -> Directive

ngx_client_max_body_size

source

fn ngx_client_max_body_size(value : String) -> Directive

ngx_deny

source

fn ngx_deny(spec : String) -> Directive

ngx_error_log

source

fn ngx_error_log(path : String) -> Directive

ngx_events

source

fn ngx_events(children : Array[Directive]) -> Directive

ngx_gzip

source

fn ngx_gzip(onoff : String) -> Directive

ngx_http

source

fn ngx_http(children : Array[Directive]) -> Directive

ngx_if

source

fn ngx_if(cond : Array[String], children : Array[Directive]) -> Directive

ngx_include

source

fn ngx_include(path : String) -> Directive

ngx_index

source

fn ngx_index(names : Array[String]) -> Directive

ngx_keepalive_timeout

source

fn ngx_keepalive_timeout(value : String) -> Directive

ngx_listen

source

fn ngx_listen(addr : String) -> Directive

ngx_location

source

fn ngx_location(path : String, children : Array[Directive]) -> Directive

ngx_location_mod

source

fn ngx_location_mod(modifier : String, path : String, children : Array[Directive]) -> Directive

ngx_pid

source

fn ngx_pid(path : String) -> Directive

ngx_proxy_pass

source

fn ngx_proxy_pass(url : String) -> Directive

ngx_return_code

source

fn ngx_return_code(code : String) -> Directive

ngx_return_url

source

fn ngx_return_url(code : String, url : String) -> Directive

ngx_rewrite

source

fn ngx_rewrite(regex : String, replacement : String) -> Directive

ngx_root

source

fn ngx_root(path : String) -> Directive

ngx_sendfile

source

fn ngx_sendfile(onoff : String) -> Directive

ngx_server

source

fn ngx_server(children : Array[Directive]) -> Directive

ngx_server_name

source

fn ngx_server_name(name : String) -> Directive

ngx_set

source

fn ngx_set(variable : String, value : String) -> Directive

ngx_try_files

source

fn ngx_try_files(args : Array[String]) -> Directive

ngx_upstream

source

fn ngx_upstream(name : String, children : Array[Directive]) -> Directive

ngx_upstream_server

source

fn ngx_upstream_server(addr : String) -> Directive

ngx_worker_connections

source

fn ngx_worker_connections(n : String) -> Directive

ngx_worker_processes

source

fn ngx_worker_processes(n : String) -> Directive

parse_and_validate

source

fn parse_and_validate(text : String) -> Result[Config, NgxError]

parse_conf

source

fn parse_conf(text : String) -> Result[Config, NgxError]

parse_conf_named

source

fn parse_conf_named(file : String, text : String) -> Result[Config, NgxError]

parse_dump

source

fn parse_dump(text : String) -> Result[String, NgxError]

payload_json

source

fn payload_json(cfg : Config) -> Json

payload_text

source

fn payload_text(cfg : Config) -> String

proxy_backends

source

fn proxy_backends(cfg : Config) -> Array[String]

rewrite_rules

source

fn rewrite_rules(cfg : Config) -> Array[(String, String)]

roundtrip

source

fn roundtrip(text : String) -> Result[String, NgxError]

servers_of

source

fn servers_of(cfg : Config) -> Array[Directive]

supported_blocks

source

fn supported_blocks() -> Array[String]

syntax_profile

source

fn syntax_profile() -> String

unwrap_ngx

source

fn[T] unwrap_ngx(r : Result[T, NgxError]) -> T

upstream_peers

source

fn upstream_peers(cfg : Config, name : String) -> Array[String]

validate_core

source

fn validate_core(cfg : Config) -> Result[Unit, NgxError]

Source Files

Site source Report issue Packages Build queue Skills Statistics

moonnginx

#MoonNginx

#Install

#Parse and dump

#Three runnable scenarios

#Verify

#Boundary

#License

#Config

#Config::find

#Config::find_all

#Directive

#Directive::arg0

#Directive::child

#Directive::is_block

#Directive::is_comment

#Directive::is_include

#NgxError

#NgxError::message

#Tok

#TokKind

#build_config

#collect_names

#config_json

#config_ok

#count_directives

#dir_block

#dir_comment

#dir_simple

#dump_conf

#empty_config

#first_server_name

#has_ssl

#includes_of

#known_core_directive

#library_name

#line_msg

#listen_addrs

#location_paths

#locations_of

#ngx_access_log

#ngx_add_header

#ngx_allow

#ngx_client_max_body_size

#ngx_deny

#ngx_error_log

#ngx_events

#ngx_gzip

#ngx_http

#ngx_if

#ngx_include

#ngx_index

#ngx_keepalive_timeout

#ngx_listen

#ngx_location

#ngx_location_mod

#ngx_pid

#ngx_proxy_pass

#ngx_return_code

#ngx_return_url

#ngx_rewrite

#ngx_root

#ngx_sendfile

#ngx_server

#ngx_server_name

#ngx_set

#ngx_try_files

#ngx_upstream

#ngx_upstream_server

#ngx_worker_connections

#ngx_worker_processes

#parse_and_validate

#parse_conf

#parse_conf_named

#parse_dump

#payload_json

#payload_text

#proxy_backends

#rewrite_rules

#roundtrip

Config

Config::find

Config::find_all

Directive

Directive::arg0

Directive::child

Directive::is_block

Directive::is_comment

Directive::is_include

NgxError

NgxError::message

Tok

TokKind

build_config

collect_names

config_json

config_ok

count_directives

dir_block

dir_comment

dir_simple

dump_conf

empty_config

first_server_name

has_ssl

includes_of

known_core_directive

library_name

line_msg

listen_addrs

location_paths

locations_of

ngx_access_log

ngx_add_header

ngx_allow

ngx_client_max_body_size

ngx_deny

ngx_error_log

ngx_events

ngx_gzip

ngx_http

ngx_if

ngx_include

ngx_index

ngx_keepalive_timeout

ngx_listen

ngx_location

ngx_location_mod

ngx_pid

ngx_proxy_pass

ngx_return_code

ngx_return_url

ngx_rewrite

ngx_root

ngx_sendfile

ngx_server

ngx_server_name

ngx_set

ngx_try_files

ngx_upstream

ngx_upstream_server

ngx_worker_connections

ngx_worker_processes

parse_and_validate

parse_conf

parse_conf_named

parse_dump

payload_json

payload_text

proxy_backends

rewrite_rules

roundtrip

servers_of

supported_blocks

syntax_profile

unwrap_ngx

upstream_peers

validate_core