docs(tvix/eval): add docstrings for usize wrappers in opcode
Change-Id: I11b9324233c0aa48bd2fbac15a484962f925e72e Reviewed-on: https://cl.tvl.fyi/c/depot/+/6283 Tested-by: BuildkiteCI Reviewed-by: sterni <sternenseemann@systemli.org>
This commit is contained in:
		
							parent
							
								
									4f00f75e31
								
							
						
					
					
						commit
						2cdc6192b4
					
				
					 1 changed files with 3 additions and 0 deletions
				
			
		| 
						 | 
					@ -1,14 +1,17 @@
 | 
				
			||||||
//! This module implements the instruction set running on the abstract
 | 
					//! This module implements the instruction set running on the abstract
 | 
				
			||||||
//! machine implemented by tvix.
 | 
					//! machine implemented by tvix.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					/// Index of a constant in the current code chunk.
 | 
				
			||||||
#[repr(transparent)]
 | 
					#[repr(transparent)]
 | 
				
			||||||
#[derive(Clone, Copy, Debug)]
 | 
					#[derive(Clone, Copy, Debug)]
 | 
				
			||||||
pub struct ConstantIdx(pub usize);
 | 
					pub struct ConstantIdx(pub usize);
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					/// Index of an instruction in the current code chunk.
 | 
				
			||||||
#[repr(transparent)]
 | 
					#[repr(transparent)]
 | 
				
			||||||
#[derive(Clone, Copy, Debug)]
 | 
					#[derive(Clone, Copy, Debug)]
 | 
				
			||||||
pub struct CodeIdx(pub usize);
 | 
					pub struct CodeIdx(pub usize);
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					/// Offset by which an instruction pointer should change in a jump.
 | 
				
			||||||
#[repr(transparent)]
 | 
					#[repr(transparent)]
 | 
				
			||||||
#[derive(Clone, Copy, Debug)]
 | 
					#[derive(Clone, Copy, Debug)]
 | 
				
			||||||
pub struct JumpOffset(pub usize);
 | 
					pub struct JumpOffset(pub usize);
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue