標準ライブラリ
stdlib の概要、モジュールの import 方法、API ドキュメントの生成。
標準ライブラリ
Sounio の標準ライブラリはリポジトリの stdlib/ にあります。基本的なデータ構造、I/O、数学、ドメインモジュール(エピステミック計算、科学計算など)を提供します。
モジュールの import
Sounio は use と import の両方をサポートします(パーサは多くのケースで両方を受け付けます)。
テストや例に見られる形:
use math::*
import stdlib.math.*
実用メモ: 迷ったら、欲しいモジュールをリポジトリ内で検索して、使われている import 形式をそのまま真似してください。
まず読むなら
stdlib/core/:Option<T>,Result<T, E>, 基本トレイトstdlib/io/: コンソール + filesystem APIstdlib/math/: スカラー数学ユーティリティstdlib/collections/:Vec、map/set(利用可能な場合)stdlib/epistemic/:Knowledge<T>の設計と意味論
API ドキュメント(生成)
リポジトリにはドキュメントジェネレータがあります:
# Generate HTML docs for stdlib into a directory
cargo run --bin souniodoc -- generate stdlib --output website/public/api
その後、サイトを起動して /api/ を開いてください。
注: 生成物は通常ビルド成果物として扱うべきです(意図的に vendor する場合を除き、コミットしない)。