The crypt4gh-rust from ega-archive

Deprecation notice

    Finished release [optimized] target(s) in 58.80s
warning: the following packages contain code that will be rejected by a future version of Rust: rustc-serialize v0.3.24
note: to see what the problems were, use the option `--future-incompat-report`, or run `cargo report future-incompatibilities --id 1`

Returning a `Result` rather than using `assert!` for error conditions

There's a few places where an assert! is used to check for a condition instead of a Result returning an Err. It might be nice to have these assert!s converted to Crypt4GHErrors.

For example:

crypt4gh-rust/src/header.rs

Lines 319 to 336 in ce0c336

    
           pub fn deconstruct_header_info( 
        
           	header_info_file: &[u8; std::mem::size_of::<HeaderInfo>()], 
        
           ) -> Result<HeaderInfo, Crypt4GHError> { 
        
           	let header_info = 
        
           		bincode::deserialize::<HeaderInfo>(header_info_file).map_err(|e| Crypt4GHError::ReadHeaderError(e))?; 
        
           	assert!( 
        
           		&header_info.magic_number == MAGIC_NUMBER, 
        
           		"Not a CRYPT4GH formatted file" 
        
           	); 
        
           	assert!( 
        
           		header_info.version == VERSION, 
        
           		"Unsupported CRYPT4GH version (version = {})", 
        
           		header_info.version 
        
           	); 
        
           	Ok(header_info) 
        
           }

could return something like a Crypt4GH::MagicStringError if the magic string is not correct.

This would give the opportunity for library consumers of the crate to choose what to do when encountering an invalid Crypt4GH file.

I'd be happy to fork/PR some changes for this.

/cc @brainstorm

ega-archive / crypt4gh-rust Goto Github PK

crypt4gh-rust's People

Contributors

Stargazers

Watchers

Forkers

crypt4gh-rust's Issues

Deprecation notice

Returning a `Result` rather than using `assert!` for error conditions

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent

	pub fn deconstruct_header_info(
	header_info_file: &[u8; std::mem::size_of::<HeaderInfo>()],
	) -> Result<HeaderInfo, Crypt4GHError> {
	let header_info =
	bincode::deserialize::<HeaderInfo>(header_info_file).map_err(\|e\| Crypt4GHError::ReadHeaderError(e))?;

	assert!(
	&header_info.magic_number == MAGIC_NUMBER,
	"Not a CRYPT4GH formatted file"
	);
	assert!(
	header_info.version == VERSION,
	"Unsupported CRYPT4GH version (version = {})",
	header_info.version
	);

	Ok(header_info)
	}