char/matrix-rust-sdk
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Make Client::send a public method, add a short doccomment

Browse source
This commit is contained in:
Emi Simpson 2020-05-20 14:24:35 -04:00
parent 1d9fccdc9f
commit 53876ea6e8
No known key found for this signature in database
GPG key ID: 68FAB2E2E6DFC98B
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
matrix_sdk/src/client.rs
View file

@ -916,7 +916,17 @@ impl Client {
}
}
async fn send<Request: Endpoint<ResponseError = crate::api::Error> + std::fmt::Debug>(
/// Send an arbitrary request to the server, without updating client state
///
/// **Warning:** Because this method *does not* update the client state, it is
/// important to make sure than you account for this yourself, and use wrapper methods
/// where available. This method should *only* be used if a wrapper method for the
/// endpoint you'd like to use is not available.
///
/// # Arguments
///
/// * `request` - A filled out and valid request for the endpoint to be hit
pub async fn send<Request: Endpoint<ResponseError = crate::api::Error> + std::fmt::Debug>(
&self,
request: Request,
) -> Result<Request::Response> {