doc(native-mode): add docstring for get_elf and get_cycles

prajwolrg · prajwolrg · commit aea79601d995 · 2025-12-17T21:08:22.000+05:45
diff --git a/adapters/native/src/host.rs b/adapters/native/src/host.rs
@@ -39,10 +39,15 @@ impl ZkVmExecutor for NativeHost {
         Ok(public_values)
     }
 
+    /// Returns an empty slice as there is no ELF in native mode.
     fn get_elf(&self) -> &[u8] {
         &[]
     }
 
+    /// Returns 0 as cycle counting is not applicable in native mode.
+    ///
+    /// For RISC-V ZkVms, cycles are obtained by emulating execution and counting
+    /// instructions. There is no straightforward equivalent for native execution.
     fn get_cycles<'a>(
         &self,
         _input: <Self::Input<'a> as zkaleido::ZkVmInputBuilder<'a>>::Input,

Original file line number	Diff line number	Diff line change
`@@ -39,10 +39,15 @@ impl ZkVmExecutor for NativeHost {`
`39`	`39`	`Ok(public_values)`
`40`	`40`	`}`
`41`	`41`
	`42`	`+ /// Returns an empty slice as there is no ELF in native mode.`
`42`	`43`	`fn get_elf(&self) -> &[u8] {`
`43`	`44`	`&[]`
`44`	`45`	`}`
`45`	`46`
	`47`	`+ /// Returns 0 as cycle counting is not applicable in native mode.`
	`48`	`+ ///`
	`49`	`+ /// For RISC-V ZkVms, cycles are obtained by emulating execution and counting`
	`50`	`+ /// instructions. There is no straightforward equivalent for native execution.`
`46`	`51`	`fn get_cycles<'a>(`
`47`	`52`	`&self,`
`48`	`53`	`_input: <Self::Input<'a> as zkaleido::ZkVmInputBuilder<'a>>::Input,`