Struct icu::datetime::fieldset::serde::CompositeFieldSetSerde

pub struct CompositeFieldSetSerde { /* private fields */ }

🚧 [Experimental] A type corresponding to CompositeFieldSet that implements serde::Serialize and serde::Deserialize.

The serialized representation is subject to change.

🚧 This code is experimental; it may change at any time, in breaking or non-breaking ways, including in SemVer minor releases. Use with caution. #5825

Examples

use icu::datetime::fieldset;
use icu::datetime::fieldset::dynamic::CompositeFieldSet;
use icu::datetime::fieldset::dynamic::DateFieldSet;
use icu::datetime::fieldset::serde::CompositeFieldSetSerde;

let field_set = CompositeFieldSet::Date(DateFieldSet::YMD(fieldset::YMD::short()));
let serde_input = CompositeFieldSetSerde::from(field_set);

let json_string = serde_json::to_string(&serde_input).unwrap();
assert_eq!(
    json_string,
    r#"{"fieldSet":["year","month","day"],"length":"short"}"#
);

let serde_output = serde_json::from_str::<CompositeFieldSetSerde>(&json_string).unwrap();
let deserialized = CompositeFieldSet::try_from(serde_output).unwrap();

assert_eq!(field_set, deserialized);

If the field set is invalid, an error will occur:

use icu::datetime::fieldset::dynamic::CompositeFieldSet;
use icu::datetime::fieldset::serde::CompositeFieldSetSerde;
use icu::datetime::fieldset::serde::CompositeFieldSetSerdeError;

let json_string = r#"{"fieldSet":["year","time"],"length":"short"}"#;
let serde_output = serde_json::from_str::<CompositeFieldSetSerde>(&json_string).unwrap();

assert!(matches!(
    CompositeFieldSet::try_from(serde_output),
    Err(CompositeFieldSetSerdeError::InvalidFields)
));

Trait Implementations

impl Clone for CompositeFieldSetSerde

fn clone(&self) -> CompositeFieldSetSerde

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CompositeFieldSetSerde

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CompositeFieldSetSerde

fn deserialize<__D>( __deserializer: __D, ) -> Result<CompositeFieldSetSerde, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CompositeFieldSet> for CompositeFieldSetSerde

fn from(value: CompositeFieldSet) -> CompositeFieldSetSerde

Converts to this type from the input type.

impl PartialEq for CompositeFieldSetSerde

fn eq(&self, other: &CompositeFieldSetSerde) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CompositeFieldSetSerde

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CompositeFieldSetSerde> for CompositeFieldSet

type Error = CompositeFieldSetSerdeError

The type returned in the event of a conversion error.

fn try_from( value: CompositeFieldSetSerde, ) -> Result<CompositeFieldSet, <CompositeFieldSet as TryFrom<CompositeFieldSetSerde>>::Error>

Performs the conversion.

impl Copy for CompositeFieldSetSerde

impl StructuralPartialEq for CompositeFieldSetSerde