Plugins
crate nautilus-plugin กำหนดสัญญา (contract) ของ artifact สำหรับ plug-in ของ NautilusTrader plug-in คือ
Rust cdylib ที่คอมไพล์แยกอิสระ ระบุตัวตนด้วย manifest ที่มีเวอร์ชัน และแลกเปลี่ยนค่าข้ามขอบเขต C-ABI
crate นี้ครอบคลุมเพียงการระบุตัวตนของ artifact และ primitive สำหรับขอบเขตเท่านั้น ไม่ได้ทำหน้าที่ load, register หรือรัน plug-in ตัว host ที่ทำการ load เป็นรายละเอียดภายในของการ deploy Nautilus ซึ่งอยู่นอก repository นี้
ABI ของ plug-in ยังอยู่ในระยะ early alpha และ contract ยังไม่เสถียร ควร pin การ build plug-in ให้ตรงกับ
เวอร์ชันของ nautilus-plugin
สัญญาของ artifact
plug-in คือ Rust cdylib ที่ export entry symbol เพียงตัวเดียวคือ nautilus_plugin_init
macro nautilus_plugin! จะสร้าง symbol นั้นพร้อมกับ manifest แบบ static ที่บรรจุข้อมูลระบุตัวตนของ build:
nautilus_plugin::nautilus_plugin! {
name: "example-plugin",
vendor: "Nautech",
version: env!("CARGO_PKG_VERSION"),
}name และ version เป็นค่าบังคับ ส่วน vendor มีค่าเริ่มต้นเป็น string ว่าง เรียก macro เพียงครั้งเดียวต่อ
artifact ที่ระดับ module ตั้ง crate-type = ["cdylib"] ใน Cargo.toml ของ artifact และใช้ dependency
nautilus-plugin เวอร์ชันที่ตรงกัน
ความเข้ากันได้ของ manifest
nautilus_plugin_init รับ host pointer แบบ opaque และคืน PluginManifest ที่เก็บอยู่ในหน่วยความจำซึ่งมีอายุเท่ากับ
process หาก host pointer เป็น null หรือการเรียกเกิด panic จะคืนค่า null PluginManifest::validate ตรวจสอบ
invariant ที่ host ต้องพึ่งพาก่อนการ register โดยจะรายงานปัญหาเชิงโครงสร้างทุกข้อที่พบ และล้มเหลวเมื่อ:
abi_versionไม่เท่ากับNAUTILUS_PLUGIN_ABI_VERSIONหรือbuild_id.schema_versionไม่เท่ากับPLUGIN_BUILD_ID_VERSIONplugin_nameหรือplugin_versionว่าง- string ใดใน manifest ผิดรูปแบบ: เป็น null pointer แต่มีความยาวไม่เป็นศูนย์ หรือมี byte ที่ไม่ใช่ UTF-8 ที่ถูกต้อง
build_id.precision_modeหรือbuild_id.fixed_precisionต่างจากของ host build
ต้องตรวจสอบ precision เพราะมันเปลี่ยน layout ของ model type ที่ข้ามขอบเขต ส่วนฟิลด์ระบุตัวตนของ build ที่เหลือ
(เวอร์ชัน nautilus-plugin, เวอร์ชัน rustc, target triple และ build profile) ใช้สำหรับการวินิจฉัยเท่านั้น
กฎของขอบเขต
เฉพาะ type แบบ #[repr(C)] ใน nautilus_plugin::boundary และ type แบบ #[repr(C)] ที่สร้างจาก type เหล่านั้น
เท่านั้นที่ปรากฏใน signature ที่ข้ามขอบเขตได้ String, Vec และ Box<dyn Trait> อาศัย ABI ของ Rust ซึ่งไม่เสถียร
จึงห้ามข้ามขอบเขตเด็ดขาด panic ก็ห้าม unwind ข้ามขอบเขตเช่นกัน entry symbol ที่ถูกสร้างขึ้นจะดักจับ panic
และคืนค่า null
ภายใต้ ABI ปัจจุบัน plug-in จะไม่ถูก unload ดังนั้นหน่วยความจำของ manifest จึงใช้ได้ตลอดอายุของ process
ดู type ของขอบเขตและ manifest ได้ที่เอกสารของ crate
แปลจาก เอกสาร NautilusTrader © Nautech Systems Pty Ltd และผู้ร่วมพัฒนา เผยแพร่ภายใต้ LGPL-3.0 ฉบับแปลนี้ตัดเนื้อหาเฉพาะ Python ออกและเน้น Rust