Modelado y serialización de datos

Ejemplo de Struct personalizado

El siguiente código define una muestra de Vegetable struct que implementa los rasgos de serialización de serde:

#[derive(Serialize, Deserialize)]
struct Vegetable {
    name: String,
    category: String,
    tropical: bool,
}

El siguiente código accede a la colección vegetables con Vegetable como su parámetro de tipo genérico:

let my_coll: Collection<Vegetable> = client
    .database("db")
    .collection("vegetables");

Como la instancia Collection está parametrizada con la estructura Vegetable, puedes realizar operaciones CRUD con este tipo. El siguiente código inserta una instancia de Vegetable en la colección:

let calabash = Vegetable {
    name: "calabash".to_string(),
    category: "gourd".to_string(),
    tropical: true,
};
my_coll.insert_one(calabash, None).await?;

Parametrizaciones múltiples

Si tu colección contiene varios esquemas, puedes definir un tipo personalizado para modelar cada tipo de dato y crear clones de la instancia original de Collection para cada tipo. Puedes crear clones de una instancia de Collection usando el método clone_with_type().

Supongamos que inicialmente parametrizaste una colección con una estructura denominada Square, pero luego te das cuenta de que deseas insertar un tipo diferente de datos, modelado por la estructura Circle, en la colección. El siguiente código parametriza una colección con el tipo Square, luego crea un clon de la colección que está parametrizada con el tipo Circle:

let shapes_coll: Collection<Square> = client
    .database("db")
    .collection("shapes");
// ... perform some operations with Square
let shapes_coll: Collection<Circle> = shapes_coll.clone_with_type();
// ... perform some operations with Circle

Serializar un String como un ObjectId

Podrías querer representar el campo _id en un documento como una cadena hexadecimal en tu estructura. Para convertir la cadena hexadecimal al tipo BSON ObjectId, utiliza la función asistente serialize_hex_string_as_object_id como valor del atributo serialize_with. El siguiente ejemplo adjunta el atributo serialize_with al campo _id para que el controlador serialice la cadena hexadecimal como un tipo ObjectId:

#[derive(Serialize, Deserialize)]
struct Order {
    #[serde(serialize_with = "serialize_hex_string_as_object_id")]
    _id: String,
    item: String,
}

Para ver cómo el driver serializa una muestra de struct Order a BSON, selecciona una de las siguientes opciones Struct y pestañas BSON:

let order = Order {
    _id: "6348acd2e1a47ca32e79f46f".to_string(),
    item: "lima beans".to_string(),
};

{
  "_id": { "$oid": "6348acd2e1a47ca32e79f46f" },
  "item": "lima beans"
}

Serializar un DateTime como una string

Puede que desees representar el valor de un DateTime campo en un documento como una string en formato ISO en BSON. Para especificar esta conversión, usa la función asistente serialize_bson_datetime_as_rfc3339_string como valor del atributo serialize_with adjunto al campo con un valor DateTime. El siguiente ejemplo adjunta el atributo serialize_with al campo delivery_date para que el driver serialice el valor DateTime a un string:

#[derive(Serialize, Deserialize)]
struct Order {
    item: String,
    #[serde(serialize_with = "serialize_bson_datetime_as_rfc3339_string")]
    delivery_date: DateTime,
}

Para ver cómo el controlador serializa una estructura Order de ejemplo en BSON, seleccione las siguientes pestañas Struct y BSON:

let order = Order {
    item: "lima beans".to_string(),
    delivery_date: DateTime::now(),
};

{
  "_id": { ... },
  "item": "lima beans",
  "delivery_date": "2023-09-26T17:30:18.181Z"
}

Serializar un u32 como f64

Puede que quieras representar un valor de campo u32 en un documento como un f64 o Double tipo en BSON. Para especificar esta conversión, usa la función asistente serialize_u32_as_f64 como valor del atributo serialize_with adjunto al campo con un valor de u32. El siguiente ejemplo adjunta el atributo serialize_with al campo quantity para que el controlador serialice el valor u32 a un tipo Double:

#[derive(Serialize, Deserialize)]
struct Order {
    item: String,
    #[serde(serialize_with = "serialize_u32_as_f64")]
    quantity: u32,
}

Otros atributos y módulos

Además de las funciones auxiliares, la librería bson provee módulos que gestionan tanto la serialización como la deserialización. Para seleccionar un módulo para usar en un campo o variante específica, define el valor del atributo with con el nombre del módulo:

#[derive(Serialize, Deserialize)]
struct MyStruct {
    #[serde(with = "<module>")]
    field1: u32,
    // ... other fields
}

Para ver una lista completa de estos módulos, consulta la documentación de la API serde_helpers.

La serde caja proporciona muchos otros atributos para personalizar la serialización. La siguiente lista describe algunos atributos comunes y su funcionalidad:

• renameserializar y deserializar un campo con un nombre especificado en lugar del nombre de la struct o variante de Rust

• skip: no serializar o deserializar el campo especificado

• defaultSi no hay un valor presente durante la deserialización, usa el valor por defecto de Default::default()

Para una lista completa de atributos de serde, consulta la Documentación API de atributos serde.

Documentación de la API

Para obtener más información sobre los métodos y tipos mencionados en esta guía, vea la siguiente documentación de la API:

• colección()

• clone_with_type()

• serialize_with Atributo Serde

• deserialize_with Atributo Serde

• con Atributo Serde