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

serde: Improve docs of Raw

Browse Source
This commit is contained in:
Kévin Commaille 2024-11-29 11:56:54 +01:00 committed by strawberry
parent f2b58e5e07
commit 9c9b1f7e93
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
crates/ruma-common/src/serde/raw.rs
View File

@ -16,8 +16,9 @@ use serde_json::value::{to_raw_value as to_raw_json_value, RawValue as RawJsonVa
/// Ruma offers the `Raw` wrapper to enable passing around JSON text that is only partially /// Ruma offers the `Raw` wrapper to enable passing around JSON text that is only partially
/// validated. This is useful when a client receives events that do not follow the spec perfectly /// validated. This is useful when a client receives events that do not follow the spec perfectly
/// or a server needs to generate reference hashes with the original canonical JSON string. /// or a server needs to generate reference hashes with the original canonical JSON string.
/// All event structs and enums implement `Serialize` / `Deserialize`, `Raw` should be used /// All structs and enums representing event types implement `Deserialize`, therefore they can be
/// to pass around events in a lossless way. /// used with `Raw`. Since `Raw` does not change the JSON string, it should be used to pass around
/// events in a lossless way.
/// ///
/// ```no_run /// ```no_run
/// # use serde::Deserialize; /// # use serde::Deserialize;