Struct mockall::examples::__mock_MockFoo_Foo::__bean::Expectation
source · pub struct Expectation { /* private fields */ }
Expand description
Expectation type for methods that return a 'static
type.
This is the type returned by the expect_*
methods.
Implementations§
source§impl Expectation
impl Expectation
sourcepub fn return_const<MockallOutput>(
&mut self,
__mockall_c: MockallOutput,
) -> &mut Self
pub fn return_const<MockallOutput>( &mut self, __mockall_c: MockallOutput, ) -> &mut Self
Return a constant value from the Expectation
The output type must be Clone
. The compiler can’t always
infer the proper type to use with this method; you will
usually need to specify it explicitly. i.e.
return_const(42i32)
instead of return_const(42)
.
sourcepub fn return_const_st<MockallOutput>(
&mut self,
__mockall_c: MockallOutput,
) -> &mut Self
pub fn return_const_st<MockallOutput>( &mut self, __mockall_c: MockallOutput, ) -> &mut Self
Single-threaded version of
return_const
. This is useful for
return types that are not Send
.
The output type must be Clone
. The compiler can’t always
infer the proper type to use with this method; you will
usually need to specify it explicitly. i.e.
return_const(42i32)
instead of return_const(42)
.
It is a runtime error to call the mock method from a different thread than the one that originally called this method.
sourcepub fn return_once<MockallF>(&mut self, __mockall_f: MockallF) -> &mut Self
pub fn return_once<MockallF>(&mut self, __mockall_f: MockallF) -> &mut Self
Supply an FnOnce
closure that will provide the return
value for this Expectation. This is useful for return types
that aren’t Clone
. It will be an error to call this
method multiple times.
sourcepub fn return_once_st<MockallF>(&mut self, __mockall_f: MockallF) -> &mut Self
pub fn return_once_st<MockallF>(&mut self, __mockall_f: MockallF) -> &mut Self
Single-threaded version of
return_once
. This is useful for
return types that are neither Send
nor Clone
.
It is a runtime error to call the mock method from a different thread than the one that originally called this method. It is also a runtime error to call the method more than once.
sourcepub fn returning<MockallF>(&mut self, __mockall_f: MockallF) -> &mut Self
pub fn returning<MockallF>(&mut self, __mockall_f: MockallF) -> &mut Self
Supply a closure that will provide the return value for this
Expectation
. The method’s arguments are passed to the
closure by value.
sourcepub fn returning_st<MockallF>(&mut self, __mockall_f: MockallF) -> &mut Self
pub fn returning_st<MockallF>(&mut self, __mockall_f: MockallF) -> &mut Self
Single-threaded version of returning
.
Can be used when the argument or return type isn’t Send
.
It is a runtime error to call the mock method from a different thread than the one that originally called this method.
sourcepub fn in_sequence(&mut self, __mockall_seq: &mut Sequence) -> &mut Self
pub fn in_sequence(&mut self, __mockall_seq: &mut Sequence) -> &mut Self
Add this expectation to a
Sequence
.
sourcepub fn new() -> Self
pub fn new() -> Self
Create a new, default, Expectation
sourcepub fn once(&mut self) -> &mut Self
pub fn once(&mut self) -> &mut Self
Expect this expectation to be called exactly once. Shortcut for
times(1)
.
sourcepub fn times<MockallR>(&mut self, __mockall_r: MockallR) -> &mut Selfwhere
MockallR: Into<TimesRange>,
pub fn times<MockallR>(&mut self, __mockall_r: MockallR) -> &mut Selfwhere
MockallR: Into<TimesRange>,
Restrict the number of times that that this method may be called.
The argument may be:
- A fixed number:
.times(4)
- Various types of range:
.times(5..10)
.times(..10)
.times(5..)
.times(5..=10)
.times(..=10)
- The wildcard:
.times(..)
sourcepub fn with(&mut self) -> &mut Self
pub fn with(&mut self) -> &mut Self
Set matching criteria for this Expectation.
The matching predicate can be anything implemening the
Predicate
trait. Only
one matcher can be set per Expectation
at a time.