Skip to main content

UnknownFields

Enum UnknownFields 

Source
#[non_exhaustive]
pub enum UnknownFields { Ignore, Error, Collect(IgnoredFields), }
Expand description

What happens with keys of structs that no field takes.

Derived structs ignore keys they do not know by default. This policy changes that for all structs of a deserialization, while #[deser(deny_unknown_fields)] rejects unknown keys for a single type regardless of the policy. It’s an extension value, usually configured in the Context (or in the State of a single deserialization, see set). To collect the unknown keys of a single deserialization see IgnoredFields.

Only the struct that the key is given to decides: flattened fields are asked if they take a key first (see value_for_key), so a key is only unknown if neither the struct nor any of its flattened fields take it.

use deser::de::UnknownFields;
use deser::{Context, Deserialize};

#[derive(Deserialize, Debug)]
struct Config {
    name: String,
}

let config = deser_json::DeserializerConfig::builder()
    .context(Context::with(UnknownFields::Error))
    .build();
let err = config
    .from_str::<Config>(r#"{"name": "demo", "nmae": "demo"}"#)
    .unwrap_err();
assert_eq!(err.message(), "unknown field `nmae`, expected `name`");

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Ignore

Unknown keys are ignored.

§

Error

Unknown keys are rejected.

§

Collect(IgnoredFields)

Unknown keys are ignored but reported to a IgnoredFields.

The collector is shared, so this is meant for a single deserialization (see IgnoredFields).

Implementations§

Source§

impl UnknownFields

Source

pub fn of(state: &State) -> &UnknownFields

Returns the policy of a deserialization.

Source

pub fn set(self, state: &mut State)

Sets the policy of a deserialization.

Trait Implementations§

Source§

impl Clone for UnknownFields

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for UnknownFields

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for UnknownFields

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.