pub struct MockClientBuilder { /* private fields */ }
Available on crate feature
testing
only.Expand description
An augmented ClientBuilder
that also allows for handling session login.
Implementations§
Source§impl MockClientBuilder
impl MockClientBuilder
Sourcepub fn new(homeserver: Option<&str>) -> Self
pub fn new(homeserver: Option<&str>) -> Self
Create a new MockClientBuilder
connected to the given homeserver,
using Matrix V1.12, and which will not attempt any network retry (by
default).
If no homeserver is provided, http://localhost
is used as a homeserver.
Sourcepub fn no_server_versions(self) -> Self
pub fn no_server_versions(self) -> Self
Don’t cache server versions in the client.
Sourcepub fn server_versions(self, versions: Vec<MatrixVersion>) -> Self
pub fn server_versions(self, versions: Vec<MatrixVersion>) -> Self
Set the cached server versions in the client.
Sourcepub fn unlogged(self) -> Self
pub fn unlogged(self) -> Self
Doesn’t log-in a user.
Authenticated requests will fail if this is called.
Sourcepub fn registered_with_oauth(self) -> Self
pub fn registered_with_oauth(self) -> Self
The client is registered with the OAuth 2.0 API.
Sourcepub fn logged_in_with_oauth(self) -> Self
pub fn logged_in_with_oauth(self) -> Self
The user is already logged in with the OAuth 2.0 API.
Sourcepub fn logged_in_with_token(
self,
token: String,
user_id: OwnedUserId,
device_id: OwnedDeviceId,
) -> Self
pub fn logged_in_with_token( self, token: String, user_id: OwnedUserId, device_id: OwnedDeviceId, ) -> Self
The user is already logged in with the Matrix Auth.
Sourcepub fn on_builder<F: FnOnce(ClientBuilder) -> ClientBuilder>(self, f: F) -> Self
pub fn on_builder<F: FnOnce(ClientBuilder) -> ClientBuilder>(self, f: F) -> Self
Apply changes to the underlying ClientBuilder
.
use matrix_sdk::test_utils::client::MockClientBuilder;
MockClientBuilder::new(None)
.on_builder(|builder| {
// Here it's possible to modify the underlying `ClientBuilder`.
builder
.handle_refresh_tokens()
.cross_process_store_locks_holder_name("hodor".to_owned())
})
.build()
.await;
Auto Trait Implementations§
impl Freeze for MockClientBuilder
impl !RefUnwindSafe for MockClientBuilder
impl Send for MockClientBuilder
impl Sync for MockClientBuilder
impl Unpin for MockClientBuilder
impl !UnwindSafe for MockClientBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> CompatExt for T
impl<T> CompatExt for T
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Converts
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
, which can then be
downcast
into Box<dyn ConcreteType>
where ConcreteType
implements Trait
.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Converts
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
, which can then be further
downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Converts
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Converts
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.Source§impl<T> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T, UT> HandleAlloc<UT> for T
impl<T, UT> HandleAlloc<UT> for T
Source§fn consume_handle(handle: Handle) -> Arc<T>
fn consume_handle(handle: Handle) -> Arc<T>
Consume a handle, getting back the initial
Arc<>
Source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
Source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more