1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
// vim: tw=80
//! Examples of mock objects and their generated methods.
//!
//! This crate only exists to document the autogenerated methods of the
//! [`Mockall`](https://docs.rs/mockall/latest/mockall)
//! crate. You should never depend on this crate.
#![deny(missing_docs)]
#![deny(warnings)]
#[cfg(doc)]
use mockall::*;
/// A basic trait with several kinds of method.
///
/// It is mocked by the [`MockFoo`](struct.MockFoo.html) struct.
#[cfg(doc)]
#[automock]
pub trait Foo {
/// A method with a `'static` return type
fn foo(&self, x: i32, y: i16) -> i32;
/// A method returning a reference
fn bar(&self, x: i32) -> &i32;
/// A method returning a mutable reference
fn baz(&mut self, x: i32) -> &mut i32;
/// A method returning a `'static` reference
fn bean(&self) -> &'static i32;
/// A static method
fn bang(x: i32) -> i32;
}
/// A trait implemented by a Struct we want to mock
pub trait Bah {
/// Some trait method
fn bah(&self);
}
#[cfg(doc)]
mock! {
/// structs can be mocked with `mock!`
///
/// Their mock methods have an identical API to the methods generated by
/// `#[automock]`
pub Boo {
/// A method on a struct
fn boo(&self);
}
/// An implementation of a trait on a mocked struct
trait Bah {
fn bah(&self);
}
}
#[cfg(doc)]
#[automock(mod mock_ffi;)]
extern "C" {
/// A foreign "C" function
pub fn ffi_func();
}
#[cfg(all(doc, feature = "nightly"))]
/// Mock this entire module
#[automock]
mod a_module {
/// A function in a mocked module
pub fn modfunc() {
unimplemented!()
}
}