Struct serde_pod::de::Deserializer

pub struct Deserializer<BO, R> { /* fields omitted */ }

Структура для десериализации потока байт, практически из значений, как они хранятся в памяти, в значения Rust.

Правила десериализации

Все типы десериализуются максимально прямолинейно, так, как они лежат в памяти: для всех целых типов читается соответствующее их разрядности количество байт и интерпретируется в соответствии с порядком байт BO.

Для структур и кортежей рекурсивно десериализуются их поля, без разделителей между ними. Если такие разделители требуются, они должны быть внедрены непосредственно в структуру или кортеж.

Тип () при десериализации всегда считается присутствующим, когда запрашивается.

Newtype типы десериализуются, как оборачиваемое ими значение. Так как десериализация произвольных данных все равно не поддерживается, вызывающий код всегда будет знать, в какой именно тип он должен обернуть возвращенные данные, таким образом маркер типа даже не требуется.

При десериализации строк байты интерпретируются в кодировке UTF-8, являющейся нативной для Rust. В случае, если требуется читать строки в других кодировках, оберните их в структуры, для которых будет реализован типах Deserialize, выполняющий чтение массива байт из потока и конвертирующий его в строку с помощью требуемой кодировки, например, используя крейт encoding. Чтение строки продолжается до конца потока, т.к. десериализатор не способен самостоятельно определить длину строки. В случае, если поток содержит некорректные UTF-8 данные, то возвращается ошибка Error::Encoding.

При десериализации элемента типа char из потока читается требуемое количество байт (от 1 до 4-х) его UTF-8 представления; если в процессе чтения выясняется, что байты не составляют корректно кодированное значение символа в UTF-8, возвращается ошибка Error::Encoding.

Десериализация последовательностей без определенной длины (таких, как вектор) осуществляется простой последовательной десериализацией их элементов до тех пор, пока в потоке остаются данные. Ни количество, ни разделители между элементами, ни какой-либо маркер конца последовательности не читаются. В случае, если они требуются для корректной десериализации, они должны быть добавлены в сериализуемые структуры вручную. Для последовательностей с известной длиной (например, массивы) читается запрошенное количество данных.

Неподдерживаемые методы

Для некоторых типов модели serde десериализация не поддержана, попытка их десериализации приводит к возврату ошибки Error::Unsupported. Также это означает, что сериализатор несимметричен по отношению к десериализатору: не все, что может быть закодировано, может быть раскодировано.

К неподдерживаемым типам модели относятся:

• Оба варианта Option -- десериализатор не способен самостоятельно их различить. При необходимости десериализации типа Option можно реализовать собственную структуру, для которой реализовать типаж Deserialize и выполнить чтение маркера типа и данных Some варианта, если в потоке записан Some вариант
• Перечисления. Также как и в предыдущем случае, десериализатор не способен самостоятельно определить, какой из вариантов записан в потоке. Стоит отметить, что данное ограничение применимо только к варианту десериализации перечислений в externally tagged виде (с внешней пометкой), который является вариантом сериализации перечислений в serde по умолчанию. В остальных случаях serde десериализует перечисления, как структуры, что уже поддерживается десериализатором.
• Тип bool также не поддерживается ввиду того, что десериализатор не знает, сколько байт читать и как их интерпретировать. Так как обычно булевы значения записываются в виде числа, не должно возникнуть проблем использовать вместо типа bool число, соответствующее его представлению в сериализованных данных.
• Десериализация произвольных данных и отображений (map) также не поддерживается. Отображения обычно будут записаны в потоке, как список пар ключ-значение, поэтому не должно возникнуть проблем десериализовывать именно такие структуры, а затем приводить их в требуемый вид.

Параметры типа

• BO: определяет порядок байт, в котором будут записаны примитивные числовые типы: u16, u32, u64, u128, i16, i32, i64, i128, f32 и f64.
• W: определяет тип, обеспечивающих сохранение сериализуемых данных в хранилище

Methods

impl<BO, R> Deserializer<BO, R> where
    R: BufRead,
    BO: ByteOrder, 

pub fn new(reader: R) -> Self

Создает десериализатор с настройками по умолчанию. Строки кодируются в UTF-8, если встречается непредставимый символ, декодирование прерывается и возвращается ошибка

Параметры

• reader: Поток, из которого будут читаться данные. Буферизация требуется для возможности определения окончания последовательностей, т.к. последовательности читаются до конца потока и требуется возможность определять, имеются ли в потоке еще данные или нет

Возвращаемое значение

Десериализатор для чтения данных из указанного потока и кодированием строк в UTF-8

Trait Implementations

impl<'de, 'a, BO, R> Deserializer<'de> for &'a mut Deserializer<BO, R> where
    R: BufRead,
    BO: ByteOrder, 

type Error = Error

The error type that can be returned if some error occurs during deserialization.

fn deserialize_i8<V>(self, visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Читает из потока 1 байт, интерпретируя его, как число со знаком

fn deserialize_u8<V>(self, visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Читает из потока 1 байт, интерпретируя его, как беззнаковое число

fn deserialize_i16<V>(self, visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i16 value.

fn deserialize_u16<V>(self, visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a u16 value.

fn deserialize_i32<V>(self, visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i32 value.

fn deserialize_u32<V>(self, visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a u32 value.

fn deserialize_i64<V>(self, visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i64 value.

fn deserialize_u64<V>(self, visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a u64 value.

fn deserialize_i128<V>(self, visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an i128 value.

fn deserialize_u128<V>(self, visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an u128 value.

fn deserialize_f32<V>(self, visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a f32 value.

fn deserialize_f64<V>(self, visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a f64 value.

fn deserialize_char<V>(self, visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a char value.

fn deserialize_str<V>(self, visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a string value and does not benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_string<V>(self, visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Читает байты до конца потока, возвращает их посетителю в виде владеющего буфера. Так как десериализатор сам не может определить, где заканчиваются данные, то для десериализации сложных структур внешний код должен ограничить размер буфера концом строки.

Прочитанные байт интерпретируются, как строка в кодировке UTF-8, в случае, если это не так, возвращается ошибка Error::Encoding

fn deserialize_bytes<V>(self, visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a byte array and does not benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_byte_buf<V>(self, visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a byte array and would benefit from taking ownership of buffered data owned by the Deserializer.

fn deserialize_unit<V>(self, visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Безусловно вызывает Visitor::visit_unit

fn deserialize_unit_struct<V>(
    self,
    _name: &'static str,
    visitor: V
) -> Result<V::Value> where
    V: Visitor<'de>, 

Безусловно вызывает Visitor::visit_unit. Аргумент _name игнорируется

fn deserialize_newtype_struct<V>(
    self,
    _name: &'static str,
    visitor: V
) -> Result<V::Value> where
    V: Visitor<'de>, 

Безусловно вызывает Visitor::visit_newtype_struct. Аргумент _name игнорируется

fn deserialize_seq<V>(self, visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Десериализует последовательность, последовательно вычитывая ее элементы, пока не кончатся данные в потоке. Элементы ничем не разделяются, никакого начального или конечного разделителя не читается: если что-либо из этого требуется, они должны быть представлены, как читаемые данные. Безусловно вызывает Visitor::visit_seq

fn deserialize_tuple<V>(self, len: usize, visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Десериализует кортеж, как последовательность его полей: безусловно вызывает Visitor::visit_seq.

fn deserialize_tuple_struct<V>(
    self,
    _name: &'static str,
    len: usize,
    visitor: V
) -> Result<V::Value> where
    V: Visitor<'de>, 

Десериализует кортеж, как последовательность его полей: безусловно вызывает Visitor::visit_seq. Аргумент _name игнорируется

fn deserialize_struct<V>(
    self,
    _name: &'static str,
    fields: &'static [&'static str],
    visitor: V
) -> Result<V::Value> where
    V: Visitor<'de>, 

Десериализует структуру, как последовательность ее полей: безусловно вызывает Visitor::visit_seq. Аргумент _name игнорируется, в аргументе fields важна только его длина

fn deserialize_any<V>(self, _visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Всегда возвращает ошибку Error::Unsupported

fn deserialize_map<V>(self, _visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Всегда возвращает ошибку Error::Unsupported

fn deserialize_bool<V>(self, _visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Всегда возвращает ошибку Error::Unsupported

fn deserialize_option<V>(self, _visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Всегда возвращает ошибку Error::Unsupported

fn deserialize_identifier<V>(self, _visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Всегда возвращает ошибку Error::Unsupported

fn deserialize_ignored_any<V>(self, _visitor: V) -> Result<V::Value> where
    V: Visitor<'de>, 

Всегда возвращает ошибку Error::Unsupported

fn deserialize_enum<V>(
    self,
    _name: &'static str,
    _variants: &'static [&'static str],
    _visitor: V
) -> Result<V::Value> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting an enum value with a particular name and possible variants.

fn is_human_readable(&self) -> bool

Determine whether Deserialize implementations should expect to deserialize their human-readable form.

impl<'a, 'de, BO, R> SeqAccess<'de> for &'a mut Deserializer<BO, R> where
    R: BufRead,
    BO: ByteOrder, 

type Error = Error

The error type that can be returned if some error occurs during deserialization.

fn next_element_seed<T>(&mut self, seed: T) -> Result<Option<T::Value>> where
    T: DeserializeSeed<'de>, 

This returns Ok(Some(value)) for the next value in the sequence, or Ok(None) if there are no more remaining items.

fn next_element<T>(&mut self) -> Result<Option<T>, Self::Error> where
    T: Deserialize<'de>, 

This returns Ok(Some(value)) for the next value in the sequence, or Ok(None) if there are no more remaining items.

fn size_hint(&self) -> Option<usize>

Returns the number of elements remaining in the sequence, if known.