icu_provider_fs/export/serializers/
mod.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
// This file is part of ICU4X. For terms of use, please see the file
// called LICENSE at the top level of the ICU4X source tree
// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).

//! Serializer configurations for the [`FilesystemExporter`].
//!
//! [`FilesystemExporter`]: super::FilesystemExporter

pub mod bincode;
pub mod json;
pub mod postcard;

#[doc(no_inline)]
pub use self::bincode::Serializer as Bincode;
#[doc(no_inline)]
pub use self::json::Serializer as Json;
#[doc(no_inline)]
pub use self::postcard::Serializer as Postcard;

use icu_provider::buf::BufferFormat;
use icu_provider::export::*;
use icu_provider::prelude::*;
use std::io;

/// A simple serializer trait that works on whole objects.
///
/// This trait is not meant to be implemented by clients.
pub trait AbstractSerializer: core::fmt::Debug {
    /// Serializes an object to a sink.
    fn serialize(
        &self,
        obj: &DataPayload<ExportMarker>,
        sink: &mut dyn io::Write,
    ) -> Result<(), DataError>;

    /// Gets the buffer format currently being serialized.
    fn get_buffer_format(&self) -> BufferFormat;

    /// This can be set to get correct CRLF on Windows.
    fn is_text_format(&self) -> bool {
        false
    }
}