mirror of
				https://github.com/haraldh/chainerror.git
				synced 2025-11-04 00:08:09 +01:00 
			
		
		
		
	more documentation
This commit is contained in:
		
							parent
							
								
									e3092cef89
								
							
						
					
					
						commit
						bbc9c12164
					
				
					 2 changed files with 19 additions and 0 deletions
				
			
		| 
						 | 
				
			
			@ -3,3 +3,6 @@
 | 
			
		|||
That's it for now…
 | 
			
		||||
 | 
			
		||||
Happy error handling!
 | 
			
		||||
 | 
			
		||||
To report issues, submit pull request or for the source code, examples and the book source, visit
 | 
			
		||||
the [Git Repo](https://github.com/haraldh/chainerror).
 | 
			
		||||
							
								
								
									
										16
									
								
								src/lib.rs
									
										
									
									
									
								
							
							
						
						
									
										16
									
								
								src/lib.rs
									
										
									
									
									
								
							| 
						 | 
				
			
			@ -10,6 +10,22 @@ It encapsulates all types, which have `Display + Debug` and can store the error
 | 
			
		|||
 | 
			
		||||
Along with the `ChainError<T>` struct, `chainerror` comes with some useful helper macros to save a lot of typing.
 | 
			
		||||
 | 
			
		||||
## Features
 | 
			
		||||
 | 
			
		||||
`no-fileline`
 | 
			
		||||
: completely turn off storing filename and line
 | 
			
		||||
 | 
			
		||||
`display-cause`
 | 
			
		||||
: turn on printing a backtrace of the errors in `Display`
 | 
			
		||||
 | 
			
		||||
`no-debug-cause`
 | 
			
		||||
: turn off printing a backtrace of the errors in `Debug`
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
# Tutorial
 | 
			
		||||
 | 
			
		||||
Read the [Tutorial](https://haraldh.github.io/chainerror/tutorial1.html)
 | 
			
		||||
 | 
			
		||||
# Examples
 | 
			
		||||
 | 
			
		||||
~~~rust
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue