Multi tool use

Clash Royale CLAN TAG

What are the rules for a rustdoc test of a method to pass?

I am trying to write a rustdoc test of a method called insert.
The testing function is called in the last line of the test, and when I comment it out the test passes just fine.

insert

Here is the (unhelpful) error message:

$ cargo test
...
failures:
src/blindhide.rs - blindhide::BlindHide::insert (line 34)


Could it be that there are special rules for a rustdoc test to pass (for example the use of assert! macro to prove that it returns a proper value)?

assert!

I am asking because my method passes integration test with very similar code, so I am pretty confident it's correct

The test:

/// # Examples
/// ```
/// extern crate crypsto;
/// extern crate rgb;
///
/// use std::slice;
/// use rgb::RGB;
///
/// let msg = "This is a secret message".as_bytes();
/// let img = vec![RGB {r: 0, g: 0, b: 0}; 800*500];
///
/// // Create a reference to the bytes of img
/// let p: *const Vec<RGB<u8>> = &img;
/// let p: *const u8 = p as *const u8;
/// let p: &[u8] = unsafe {
/// slice::from_raw_parts(p, 3*800*500)
/// };
///
/// let settings = crypsto::BlindHide::new(2, 12);
/// let new_data = settings.insert(p, &msg);
/// ```
pub fn insert(&self, img: &[u8], msg: &[u8]) -> Result<Vec<u8>, NoFit> {
// Number of characters that can fit
let cap = ( img.len() as f64 * self.lsb as f64 / 8_f64 )
as usize / self.step;

if msg.len() > cap {
return Err(NoFit(String::from("Message doesn't fit")));
}

let mut ret = img.to_vec();
let mut n = 0;

for ch in msg.iter() {
for i in 1..=8/self.lsb {
let shift = (self.lsb*i) as u32;
ret[n] = (ret[n] & !self.mask) |
(ch & self.mask.rotate_right(shift)).rotate_left(shift);
n += self.step;
}
}

Ok(ret)
}


By clicking "Post Your Answer", you acknowledge that you have read our updated terms of service, privacy policy and cookie policy, and that your continued use of the website is subject to these policies.