README
U
HttpHandler
U
Middleware
U
WebSocketHandler
Tr
BodyReader
Tr
Responder
Tr
ServeStaticProvider
T
CookieItem
T
Html
- ::bodyHttpRequest::body
- ::get_cookieHttpRequest::get_cookie
- ::on_completeHttpRequestInternal::on_complete
- ::on_headersHttpRequestInternal::on_headers
- ::bodyHttpResponse::body
- ::delete_cookieHttpResponse::delete_cookie
- ::jsonHttpResponse::json
- ::newHttpResponse::new
- ::set_cookieHttpResponse::set_cookie
- ::to_responderHttpResponse::to_responder
T
HttpResponseInternal
T
HttpServerInternal
- ::allMocket::all
- ::connectMocket::connect
- ::deleteMocket::delete
- ::getMocket::get
- ::groupMocket::group
- ::headMocket::head
- ::onMocket::on
- ::optionsMocket::options
- ::patchMocket::patch
- ::postMocket::post
- ::putMocket::put
- ::serveMocket::serve
- ::static_assetsMocket::static_assets
- ::traceMocket::trace
- ::use_middlewareMocket::use_middleware
- ::wsMocket::ws
T
MocketEvent
T
MultipartFormValue
T
SameSiteOption
- ::newStaticAssetMeta::new
- ::from_intStatusCode::from_int
- ::to_intStatusCode::to_int
T
WebSocketAggregatedMessage
T
WebSocketEvent
- ::binaryWebSocketPeer::binary
- ::pongWebSocketPeer::pong
- ::publishWebSocketPeer::publish
- ::subscribeWebSocketPeer::subscribe
- ::textWebSocketPeer::text
- ::to_stringWebSocketPeer::to_string
- ::unsubscribeWebSocketPeer::unsubscribe
V
__ws_emit
V
async_run
V
cookie_to_string
V
execute_middlewares
V
form_encode
V
handle_not_found
V
html
V
new
V
parse_cookie
V
parse_form_data
V
parse_multipart
V
register_ws_handler
V
serve_ffi
V
suspend
V
text
V
url_decode
V
url_encode
V
ws_pong
V
ws_publish
V
ws_send
V
ws_send_bytes
V
ws_subscribe
V
ws_unsubscribe

mocket

A web framework for MoonBit.

http

server

Download zip

Author

oboard

Version

0.6.0

License

Apache-2.0

Repository

github.com/oboard/mocket

Last updated

11 months ago

Downloads

#oboard/mocket

A web framework for MoonBit.

👉 Documentation

#Quick Start

Mocket supports both js and native backends.

#JavaScript Backend

Set the backend of MoonBit to js in Visual Studio Code

Command: MoonBit: Select Backend -> js

moon run src/example --target js

#Native Backend

Set the backend of MoonBit to native in Visual Studio Code

Command: MoonBit: Select Backend -> native

moon run src/example --target native

Then visit http://localhost:4000

#Usage

Minimum Example: https://github.com/oboard/mocket_example

#Features

#Dynamic Routes

Support named parameters with :param syntax:

app.get("/hello/:name", event => {
  let name = event.params.get("name").or("World")
  Text("Hello, \{name}!")
})

#Wildcard Routes

Support single and double wildcards:

// Single wildcard - matches one path segment
app.get("/hello/*", event => {
  let name = event.params.get("_").or("World")
  Text("Hello, \{name}!")
})

// Double wildcard - matches multiple path segments
app.get("/hello/**", event => {
  let path = event.params.get("_").or("")
  Text("Hello, \{path}!")
})

#Async Support

The library supports async/await for I/O operations:

#Async /GET Example

// async json data example
app.get("/async_data", async fn(event) {
  Json({ "name": "John Doe", "age": 30, "city": "New York" })
})

#Route Groups

Group related routes under a common base path with shared middleware:

app.group("/api", group => {
  // Add group-level middleware
  group.use_middleware(event => println(
    "🔒 API Group Middleware: \{event.req.reqMethod} \{event.req.url}",
  ))

  // Routes under /api prefix
  group.get("/hello", _ => Text("Hello from API!"))
  group.get("/users", _ => Json({ "users": ["Alice", "Bob"] }))
  group.post("/data", e => e.req.body)
})

This creates routes:

GET /api/hello
GET /api/users
POST /api/data

All routes in the group will execute the group middleware in addition to any global middleware.

#WebSocket Support

Mocket provides built-in WebSocket support with a simple event-based API.

app.ws("/ws", event => match event {
  Open(peer) => println("WS open: " + peer.to_string())
  Message(peer, body) => {
    let msg = match body {
      Text(s) => s.to_string()
      _ => ""
    }
    println("WS message: " + msg)
    peer.send(msg)
  }
  Close(peer) => println("WS close: " + peer.to_string())
})

#Example usage

let app = @mocket.new(logger=@mocket.new_debug_logger())

  // Register global middleware
  app
  ..use_middleware(event => println(
    "📝 Request: \{event.req.http_method} \{event.req.url}",
  ))

  // Text Response
  ..get("/", _event => Text("⚡️ Tadaa!"))

  // Hello World
  ..on("GET", "/hello", _ => Text("Hello world!"))
  ..group("/api", group => {
    // 添加组级中间件
    group.use_middleware(event => println(
      "🔒 API Group Middleware: \{event.req.http_method} \{event.req.url}",
    ))
    group.get("/hello", _ => Text("Hello world!"))
    group.get("/json", _ => Json({
      "name": "John Doe",
      "age": 30,
      "city": "New York",
    }))
  })

  // JSON Response
  ..get("/json", _event => Json({
    "name": "John Doe",
    "age": 30,
    "city": "New York",
  }))

  // Async Response
  ..get("/async_data", async fn(_event) noraise {
    Json({ "name": "John Doe", "age": 30, "city": "New York" })
  })

  // Dynamic Routes
  // /hello2/World = Hello, World!
  ..get("/hello/:name", event => {
    let name = event.params.get("name").unwrap_or("World")
    Text("Hello, \{name}!")
  })
  // /hello2/World = Hello, World!
  ..get("/hello2/*", event => {
    let name = event.params.get("_").unwrap_or("World")
    Text("Hello, \{name}!")
  })

  // Wildcard Routes
  // /hello3/World/World = Hello, World/World!
  ..get("/hello3/**", event => {
    let name = event.params.get("_").unwrap_or("World")
    Text("Hello, \{name}!")
  })

  // Echo Server
  ..post("/echo", e => e.req.body)

  // 404 Page
  ..get("/404", e => {
    e.res.status_code = 404
    HTML(
      (
        #|<html>
        #|<body>
        #|  <h1>404</h1>
        #|</body>
        #|</html>
      ),
    )
  })

  // Serve
  ..serve(port=4000)

  // Print Server URL
  for path in app.mappings.keys() {
    println("\{path.0} http://localhost:4000\{path.1}")
  }

#Route Matching Examples

Route Pattern	URL	Parameters
/hello/:name	/hello/world	name: "world"
/hello/*	/hello/world	_: "world"
/hello/**	/hello/foo/bar	_: "foo/bar"
/users/:id/posts/:postId	/users/123/posts/456	id: "123", postId: "456"
/api/**	/api/v1/users/123	_: "v1/users/123"
group("/api", ...).get("/hello")	/api/hello	-
group("/users", ...).get("/:id")	/users/123	id: "123"

#Q & A

#Why not moonbitlang/async ?

moonbitlang/async is a great library, but it is not supported by the js backend.

🙌快来吧！🙌

QQ 群号：949886784

HttpHandler

source

type HttpHandler = async (MocketEvent) -> &Responder noraise

Middleware

source

type Middleware = async (MocketEvent, async () -> &Responder noraise) -> &Responder noraise

WebSocketHandler

source

type WebSocketHandler = (WebSocketEvent) -> Unit

BodyReader

source

pub(open) trait BodyReader {
  from_request(req : HttpRequest) -> Self raise
}

impl BodyReader for String

impl BodyReader for FixedArray[Byte]

impl BodyReader for Bytes

impl BodyReader for Array[Byte]

impl BodyReader for Json

Responder

source

pub(open) trait Responder {
  options(Self, res : HttpResponse) -> Unit
  output(Self, buf : @moonbitlang/core/buffer.Buffer
Buffer) -> Unit
}

impl Responder for String

impl Responder for Bytes

impl Responder for Json

impl Responder for ToJson

impl Responder for StringView

ServeStaticProvider

source

pub(open) trait ServeStaticProvider {
  get_meta(Self, id : String) -> StaticAssetMeta?
  get_contents(Self, id : String) -> &Responder
  get_type(Self, ext : String) -> String?
  get_encodings(Self) -> Map[String, String]
  get_index_names(Self) -> Array[String]
  get_fallthrough(Self) -> Bool
}

ExecError

source

pub suberror ExecError

impl Show for ExecError

IOError

source

pub suberror IOError

impl Show for IOError

NetworkError

source

pub suberror NetworkError

impl Show for NetworkError

CookieItem

source

pub(all) struct CookieItem {
  name : String
  value : String
  max_age : Int?
  path : String?
  domain : String?
  secure : Bool?
  http_only : Bool?
  same_site : SameSiteOption?
}

impl Eq for CookieItem

impl Show for CookieItem

Html

source

type Html

impl Responder for Html

HttpRequest

source

pub(all) struct HttpRequest {
  http_method : String
  url : String
  headers : Map[StringView, StringView]
  raw_body : Bytes
}

impl Responder for HttpRequest

HttpRequest::body

source

fn[T : BodyReader] HttpRequest::body(self : HttpRequest) -> T raise

HttpRequest::get_cookie

source

fn HttpRequest::get_cookie(self : HttpRequest, name : String) -> CookieItem?

HttpRequestInternal

source

#external
pub type HttpRequestInternal

HttpRequestInternal::on_complete

source

fn HttpRequestInternal::on_complete(self : HttpRequestInternal, cb : FuncRef[() -> Unit]) -> Unit

HttpRequestInternal::on_headers

source

fn HttpRequestInternal::on_headers(self : HttpRequestInternal, cb : FuncRef[(@illusory0x0/native.CStr
CStr) -> Unit]) -> Unit

HttpResponse

source

pub(all) struct HttpResponse {
  status_code : StatusCode
  headers : Map[StringView, StringView]
  cookies : Map[String, CookieItem]
  raw_body : Bytes
}

impl Responder for HttpResponse

HttpResponse::body

source

fn HttpResponse::body(self : HttpResponse, body : &Responder) -> HttpResponse

HttpResponse::delete_cookie

source

fn HttpResponse::delete_cookie(self : HttpResponse, key : String) -> Unit

HttpResponse::json

source

fn HttpResponse::json(self : HttpResponse, obj : &ToJson) -> HttpResponse

HttpResponse::new

source

fn HttpResponse::new(status_code : StatusCode, headers? : Map[StringView, StringView], cookies? : Map[String, CookieItem], raw_body? : Bytes) -> HttpResponse

HttpResponse::set_cookie

source

fn HttpResponse::set_cookie(self : HttpResponse, name : String, value : String, max_age? : Int, path? : String, domain? : String, secure? : Bool, http_only? : Bool, same_site? : SameSiteOption) -> Unit

HttpResponse::to_responder

source

fn HttpResponse::to_responder(self : HttpResponse) -> &Responder

HttpResponseInternal

source

#external
pub type HttpResponseInternal

HttpServerInternal

source

#external
pub type HttpServerInternal

Mocket

source

#alias(T)
pub(all) struct Mocket {
  base_path : String
  mappings : Map[(String, String), async (MocketEvent) -> &Responder noraise]
  middlewares : Array[(String, async (MocketEvent, async () -> &Responder noraise) -> &Responder noraise)]
  static_routes : Map[String, Map[String, async (MocketEvent) -> &Responder noraise]]
  dynamic_routes : Map[String, Array[(String, async (MocketEvent) -> &Responder noraise)]]
  ws_static_routes : Map[String, (WebSocketEvent) -> Unit]
  ws_dynamic_routes : Array[(String, (WebSocketEvent) -> Unit)]
  ws_clients : Map[String, Unit]
  ws_channels : Map[String, Map[String, Unit]]
  ws_client_port : Map[String, Int]
}

Mocket::all

source

fn Mocket::all(self : Mocket, path : String, handler : async (MocketEvent) -> &Responder noraise) -> Unit

Mocket::connect

source

fn Mocket::connect(self : Mocket, path : String, handler : async (MocketEvent) -> &Responder noraise) -> Unit

Mocket::delete

source

fn Mocket::delete(self : Mocket, path : String, handler : async (MocketEvent) -> &Responder noraise) -> Unit

Mocket::get

source

fn Mocket::get(self : Mocket, path : String, handler : async (MocketEvent) -> &Responder noraise) -> Unit

Mocket::group

source

fn Mocket::group(self : Mocket, base_path : String, configure : (Mocket) -> Unit) -> Unit

Mocket::head

source

fn Mocket::head(self : Mocket, path : String, handler : async (MocketEvent) -> &Responder noraise) -> Unit

Mocket::on

source

fn Mocket::on(self : Mocket, event : String, path : String, handler : async (MocketEvent) -> &Responder noraise) -> Unit

Mocket::options

source

fn Mocket::options(self : Mocket, path : String, handler : async (MocketEvent) -> &Responder noraise) -> Unit

Mocket::patch

source

fn Mocket::patch(self : Mocket, path : String, handler : async (MocketEvent) -> &Responder noraise) -> Unit

Mocket::post

source

fn Mocket::post(self : Mocket, path : String, handler : async (MocketEvent) -> &Responder noraise) -> Unit

Mocket::put

source

fn Mocket::put(self : Mocket, path : String, handler : async (MocketEvent) -> &Responder noraise) -> Unit

Mocket::serve

source

fn Mocket::serve(self : Mocket, port~ : Int) -> Unit

Mocket::static_assets

source

fn Mocket::static_assets(self : Mocket, path : String, provider : &ServeStaticProvider) -> Unit

Mocket::trace

source

fn Mocket::trace(self : Mocket, path : String, handler : async (MocketEvent) -> &Responder noraise) -> Unit

Mocket::use_middleware

source

fn Mocket::use_middleware(self : Mocket, middleware : async (MocketEvent, async () -> &Responder noraise) -> &Responder noraise, base_path? : String) -> Unit

Mocket::ws

source

fn Mocket::ws(self : Mocket, path : String, handler : (WebSocketEvent) -> Unit) -> Unit

MocketEvent

source

pub(all) struct MocketEvent {
  req : HttpRequest
  res : HttpResponse
  params : Map[String, StringView]
}

MultipartFormValue

source

pub(all) struct MultipartFormValue {
  filename : String?
  content_type : String?
  data : BytesView
}

SameSiteOption

source

pub(all) enum SameSiteOption {
  Lax
  Strict
  SameSiteNone
}

impl Eq for SameSiteOption

impl Show for SameSiteOption

impl ToJson for SameSiteOption

StaticAssetMeta

source

pub(all) struct StaticAssetMeta {
  asset_type : String?
  etag : String?
  mtime : Int64?
  path : String?
  size : Int64?
  encoding : String?
}

StaticAssetMeta::new

source

fn StaticAssetMeta::new(asset_type? : String, etag? : String, mtime? : Int64, path? : String, size? : Int64, encoding? : String) -> StaticAssetMeta

StatusCode

source

pub(all) enum StatusCode {
  Continue
  SwitchingProtocols
  Processing
  EarlyHints
  OK
  Created
  Accepted
  NonAuthoritativeInfo
  NoContent
  ResetContent
  PartialContent
  MultiStatus
  AlreadyReported
  IMUsed
  MultipleChoices
  MovedPermanently
  Found
  SeeOther
  NotModified
  UseProxy
  TemporaryRedirect
  PermanentRedirect
  BadRequest
  Unauthorized
  PaymentRequired
  Forbidden
  NotFound
  MethodNotAllowed
  NotAcceptable
  ProxyAuthRequired
  RequestTimeout
  Conflict
  Gone
  LengthRequired
  PreconditionFailed
  RequestEntityTooLarge
  RequestUriTooLong
  UnsupportedMediaType
  RequestedRangeNotSatisfiable
  ExpectationFailed
  Teapot
  MisdirectedRequest
  UnprocessableEntity
  Locked
  FailedDependency
  TooEarly
  UpgradeRequired
  PreconditionRequired
  TooManyRequests
  RequestHeaderFieldsTooLarge
  UnavailableForLegalReasons
  InternalServerError
  NotImplemented
  BadGateway
  ServiceUnavailable
  GatewayTimeout
  HttpVersionNotSupported
  VariantAlsoNegotiates
  InsufficientStorage
  LoopDetected
  NotExtended
  NetworkAuthenticationRequired
  Custom(Int)
}

HTTP status codes as registered with IANA. See: https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

impl Show for StatusCode

impl ToJson for StatusCode

StatusCode::from_int

source

fn StatusCode::from_int(i : Int) -> StatusCode

StatusCode::to_int

source

fn StatusCode::to_int(self : StatusCode) -> Int

WebSocketAggregatedMessage

source

pub enum WebSocketAggregatedMessage {
  Text(String)
  Binary(Bytes)
  Ping
}

WebSocketEvent

source

pub enum WebSocketEvent {
  Open(WebSocketPeer)
  Message(WebSocketPeer, WebSocketAggregatedMessage)
  Close(WebSocketPeer)
}

WebSocketPeer

source

pub(all) struct WebSocketPeer {
  connection_id : String
  subscribed_channels : Array[String]
}

WebSocketPeer::binary

source

fn WebSocketPeer::binary(self : WebSocketPeer, message : Bytes) -> Unit

WebSocketPeer::pong

source

fn WebSocketPeer::pong(self : WebSocketPeer) -> Unit

WebSocketPeer::publish

source

fn WebSocketPeer::publish(channel : String, message : String) -> Unit

fn WebSocketPeer::subscribe(self : WebSocketPeer, channel : String) -> Unit

WebSocketPeer::text

source

fn WebSocketPeer::text(self : WebSocketPeer, message : String) -> Unit

WebSocketPeer::to_string

source

fn WebSocketPeer::to_string(self : WebSocketPeer) -> String

WebSocketPeer::unsubscribe

source

fn WebSocketPeer::unsubscribe(self : WebSocketPeer, channel : String) -> Unit

__ws_emit

source

fn __ws_emit(event_type : @illusory0x0/native.CStr
CStr, connection_id : @illusory0x0/native.CStr
CStr, payload : @illusory0x0/native.CStr
CStr) -> Unit

async_run

source

fn async_run(f : async () -> Unit noraise) -> Unit

cookie_to_string

source

fn cookie_to_string(cookie : Array[CookieItem]) -> String

execute_middlewares

source

async fn execute_middlewares(middlewares : Array[(String, async (MocketEvent, async () -> &Responder noraise) -> &Responder noraise)], event : MocketEvent, final_handler : async (MocketEvent) -> &Responder noraise) -> &Responder noraise

form_encode

source

fn form_encode(map : Map[String, String]) -> String

handle_not_found

source

async fn handle_not_found(_ : MocketEvent) -> &Responder noraise

html

source

fn html(html : &Show) -> &Responder

new

source

fn new(base_path? : String) -> Mocket

parse_cookie

source

fn parse_cookie(cookie : StringView) -> Map[String, CookieItem]

parse_form_data

source

fn parse_form_data(bytes : BytesView) -> Map[String, String]

parse_multipart

source

fn parse_multipart(bytes : BytesView, boundary : String) -> Map[String, MultipartFormValue]

register_ws_handler

source

fn register_ws_handler(mocket : Mocket, port : Int) -> Unit

serve_ffi

source

fn serve_ffi(mocket : Mocket, port~ : Int) -> Unit

suspend

source

async fn[T, E : Error] suspend(f : ((T) -> Unit, (E) -> Unit) -> Unit) -> T raise E

suspend 会中断当前协程的运行。 suspend 会接受一个回调函数，并让这个回调函数来操作中断的协程

text

source

fn text(text : &Show) -> &Responder

url_decode

source

fn url_decode(bytes : BytesView) -> String

url_encode

source

fn url_encode(s : String) -> String

ws_pong

source

fn ws_pong(id : String) -> Unit

ws_publish

source

fn ws_publish(channel : String, msg : String) -> Unit

ws_send

source

fn ws_send(id : String, msg : String) -> Unit

ws_send_bytes

source

fn ws_send_bytes(id : String, msg : Bytes) -> Unit

ws_subscribe

source

fn ws_subscribe(id : String, channel : String) -> Unit

ws_unsubscribe

source

fn ws_unsubscribe(id : String, channel : String) -> Unit

Site source Report issue Packages Build queue Skills Statistics

mocket

#oboard/mocket

#Quick Start

#JavaScript Backend

#Native Backend

#Usage

#Features

#Dynamic Routes

#Wildcard Routes

#Async Support

#Async /GET Example

#Route Groups

#WebSocket Support

#Example usage

#Route Matching Examples

#Q & A

#Why not moonbitlang/async ?

#HttpHandler

#Middleware

#WebSocketHandler

#BodyReader

#Responder

#ServeStaticProvider

#ExecError

#IOError

#NetworkError

#CookieItem

#Html

#HttpRequest

#HttpRequest::body

#HttpRequest::get_cookie

#HttpRequestInternal

#HttpRequestInternal::on_complete

#HttpRequestInternal::on_headers

#HttpResponse

#HttpResponse::body

#HttpResponse::delete_cookie

#HttpResponse::json

#HttpResponse::new

#HttpResponse::set_cookie

#HttpResponse::to_responder

#HttpResponseInternal

#HttpServerInternal

#Mocket

#Mocket::all

#Mocket::connect

#Mocket::delete

#Mocket::get

#Mocket::group

#Mocket::head

#Mocket::on

#Mocket::options

#Mocket::patch

#Mocket::post

#Mocket::put

#Mocket::serve

#Mocket::static_assets

#Mocket::trace

#Mocket::use_middleware

#Mocket::ws

#MocketEvent

#MultipartFormValue

#SameSiteOption

#StaticAssetMeta

#StaticAssetMeta::new

#StatusCode

#StatusCode::from_int

#StatusCode::to_int

#WebSocketAggregatedMessage

#WebSocketEvent

#WebSocketPeer

#WebSocketPeer::binary

#WebSocketPeer::pong

#WebSocketPeer::publish

#WebSocketPeer::subscribe

#WebSocketPeer::text

#WebSocketPeer::to_string

#WebSocketPeer::unsubscribe

#__ws_emit

#async_run

HttpHandler

Middleware

WebSocketHandler

BodyReader

Responder

ServeStaticProvider

ExecError

IOError

NetworkError

CookieItem

Html

HttpRequest

HttpRequest::body

HttpRequest::get_cookie

HttpRequestInternal

HttpRequestInternal::on_complete

HttpRequestInternal::on_headers

HttpResponse

HttpResponse::body

HttpResponse::delete_cookie

HttpResponse::json

HttpResponse::new

HttpResponse::set_cookie

HttpResponse::to_responder

HttpResponseInternal

HttpServerInternal

Mocket

Mocket::all

Mocket::connect

Mocket::delete

Mocket::get

Mocket::group

Mocket::head

Mocket::on

Mocket::options

Mocket::patch

Mocket::post

Mocket::put

Mocket::serve

Mocket::static_assets

Mocket::trace

Mocket::use_middleware

Mocket::ws

MocketEvent

MultipartFormValue

SameSiteOption

StaticAssetMeta

StaticAssetMeta::new

StatusCode

StatusCode::from_int

StatusCode::to_int

WebSocketAggregatedMessage

WebSocketEvent

WebSocketPeer

WebSocketPeer::binary

WebSocketPeer::pong

WebSocketPeer::publish

WebSocketPeer::subscribe

WebSocketPeer::text

WebSocketPeer::to_string

WebSocketPeer::unsubscribe

__ws_emit

async_run

cookie_to_string

execute_middlewares

form_encode

handle_not_found

html

new

parse_cookie

parse_form_data

parse_multipart

register_ws_handler

serve_ffi

suspend

text

url_decode

url_encode

ws_pong

ws_publish