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

client-api: Mention that backslashes should be escaped in filter event_fields

Browse Source 
According to MSC3980
This commit is contained in:
Kévin Commaille 2023-04-06 16:43:29 +02:00 committed by Kévin Commaille
parent ef374ea6b0
commit c1a36a2047
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
crates/ruma-client-api/src/filter.rs
View File

@ -289,8 +289,8 @@ pub struct FilterDefinition {
/// ///
/// If this list is absent then all fields are included. The entries may include '.' characters /// If this list is absent then all fields are included. The entries may include '.' characters
/// to indicate sub-fields. So ['content.body'] will include the 'body' field of the 'content' /// to indicate sub-fields. So ['content.body'] will include the 'body' field of the 'content'
/// object. A literal '.' character in a field name may be escaped using a '\'. A server may /// object. A literal '.' or '\' character in a field name may be escaped using a '\'. A server
/// include more fields than were requested. /// may include more fields than were requested.
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
pub event_fields: Option<Vec<String>>, pub event_fields: Option<Vec<String>>,