[go: up one dir, main page]

fallible_collections 0.5.1

a crate which adds fallible allocation api to std collections
Documentation

Fallible Collections.rs

Implements APIs on Rust collections wich gracefully return a Result when an allocation error occurs. This is inspired a lot by RFC 2116.

There are APIs for a fallible interface for Vec, Box, BTree, HashMap, and a TryClone trait wich is implemented for primitive Rust traits and a fallible format macro. You can use this with try_clone_derive crate wich derive TryClone for your own types.

Getting Started

fallible_collections is available on crates.io. It is recommended to look there for the newest released version, as well as links to the newest builds of the docs.

Add the following dependency to your Cargo manifest:

[dependencies]
fallible_collections = "0.5"

# or
fallible_collections = { version = "0.5", features = ["std"] }

...and see the docs for how to use it.

Example

Exemple of using the FallibleBox interface.

use fallible_collections::FallibleBox;

fn main() {
	// this crate an Ordinary box but return an error on allocation failure
	let mut a = <Box<_> as FallibleBox<_>>::try_new(5).unwrap();
	let mut b = Box::new(5);

	assert_eq!(a, b);
	*a = 3;
	assert_eq!(*a, 3);
}

Exemple of using the FallibleVec interface.

use fallible_collections::FallibleVec;

fn main() {
	// this crate an Ordinary Vec<Vec<u8>> but return an error on allocation failure
	let a: Vec<Vec<u8>> = try_vec![try_vec![42; 10].unwrap(); 100].unwrap();
	let b: Vec<Vec<u8>> = vec![vec![42; 10]; 100];
	assert_eq!(a, b);
	assert_eq!(a.try_clone().unwrap(), a);
	...
}

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.