chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update ruma_api! documentation

Browse Source
This commit is contained in:
Jonas Platte 2020-01-13 20:13:08 +01:00
parent 3b294baf07
commit 8a7e533fed
No known key found for this signature in database
GPG Key ID: 7D261D771D915378
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/lib.rs
View File

@ -126,6 +126,10 @@ use serde_urlencoded;
/// each struct can be marked with this attribute. It is an error to have a newtype body field and /// each struct can be marked with this attribute. It is an error to have a newtype body field and
/// normal body fields within the same struct. /// normal body fields within the same struct.
/// ///
/// There is another kind of newtype body that is enabled with `#[ruma_api(raw_body)]`. It is used
/// for endpoints in which the request or response body can be arbitrary bytes instead of a JSON
/// objects. A field with `#[ruma_api(raw_body)]` needs to have the type `Vec<u8>`.
///
/// # Examples /// # Examples
/// ///
/// ``` /// ```