3 unstable releases

0.2.0 Apr 29, 2024
0.1.1 Jul 25, 2023
0.1.0 Jan 9, 2022

#336 in Encoding

Download history 9/week @ 2024-03-27 14/week @ 2024-04-03 1/week @ 2024-04-10 33/week @ 2024-04-17 622/week @ 2024-04-24 370/week @ 2024-05-01 206/week @ 2024-05-08 195/week @ 2024-05-15 134/week @ 2024-05-22 165/week @ 2024-05-29 174/week @ 2024-06-05 145/week @ 2024-06-12 75/week @ 2024-06-19 69/week @ 2024-06-26 89/week @ 2024-07-03 69/week @ 2024-07-10

310 downloads per month
Used in testcontainers

MIT license

41KB
903 lines

Serde Java Properties

Docs License Version

Java Properties is a simple, line-oriented format for specifying key-value resources used in Java programs. This crate offers basic (de-)serializers for use with serde-enabled datastructures.

field_a: a value
field_b: 100
field_c: true

Implementation

Internally, the java-properties crate is used for iterating key-value pairs in an input stream, and writing key-value pairs to an output stream.

Deserializing a struct

Usually, the format is untyped i.e. it deserialises to a map from String to String. This crate uses the default std::str::FromStr implementations for integers, floats and booleans to provide a typed interface on top of that. That way, simple structures or maps that implement serde::Deserialize can be loaded from properties files.

use serde::Deserialize;

#[derive(Debug, PartialEq, Deserialize)]
struct Data {
    field_a: String,
    field_b: usize,
    field_c: bool,
}
let text = "
field_a: a value
field_b: 100
field_c: true
";

let data: Data = serde_java_properties::from_str(text).unwrap();

assert_eq!(data.field_a, "a value");
assert_eq!(data.field_b, 100);
assert_eq!(data.field_c, true);

Serializing a struct

Serialization uses the default std::fmt::Display implementations for each primitive type.

Supported in the top-level Serializer:

  • Maps
  • Structs
  • Enums of struct variants
  • Options of all of these

Supported in the field-level Serializer:

  • Integers (i8, i16, i32, i64, u8, u16, u32, u64)
  • Floats (f32, f64)
  • Booleans (true or false)
  • Strings
  • Enums of unit variants
  • Options of all of these
use serde::Serialize;

#[derive(Debug, PartialEq, Serialize)]
struct Data {
    field_a: String,
    field_b: usize,
    field_c: bool,
}

let data = Data { field_a: "value".to_string(), field_b: 100, field_c: true };
let string = serde_java_properties::to_string(&data).unwrap();

assert_eq!(string, "field_a=value\nfield_b=100\nfield_c=true\n");

Alternatives

Similar to the java-properties crate itself, this crate is supposed to be an exact match to the format as specified in Java. If you need a more powerful configuration syntax, that supports nested structs, you should probably use HOCON.

Dependencies

~6.5MB
~180K SLoC