refactor(TasmObject)!: Slim down public API

jan-ferdinand · jan-ferdinand · commit 3d3daa76d9b6 · 2025-01-14T13:25:24.000+01:00
The function `TasmObject::get_field_start_with_jump_distance` is
intended for internal use only. Mark it as such.

The function might be renamed or removed without prior warning in a
future update.
diff --git a/tasm-lib/src/structure/tasm_object.rs b/tasm-lib/src/structure/tasm_object.rs
@@ -106,6 +106,7 @@ pub trait TasmStruct: TasmObject {
     /// This function is used internally for the derive macro. You probably want to use
     /// [`get_field`](TasmObject::get_field) or
     /// [`get_field_with_size`](TasmObject::get_field_with_size) instead.
+    #[doc(hidden)]
     fn get_field_start_with_jump_distance(field_name: &str) -> Vec<LabelledInstruction>;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -106,6 +106,7 @@ pub trait TasmStruct: TasmObject {`
`106`	`106`	`/// This function is used internally for the derive macro. You probably want to use`
`107`	`107`	/// [`get_field`](TasmObject::get_field) or
`108`	`108`	/// [`get_field_with_size`](TasmObject::get_field_with_size) instead.
	`109`	`+ #[doc(hidden)]`
`109`	`110`	`fn get_field_start_with_jump_distance(field_name: &str) -> Vec<LabelledInstruction>;`
`110`	`111`	`}`
`111`	`112`