Enum ValuePointerRef

pub enum ValuePointerRef<'a> {
    Origin,
    Key {
        key: &'a str,
        prev: &'a ValuePointerRef<'a>,
    },
    Index {
        index: usize,
        prev: &'a ValuePointerRef<'a>,
    },
}

A location within a Value.

Conceptually, it is a list of choices that one has to make to go to a certain place within the value. In practice, it is used to locate the origin of a deserialization error.

Example

use deserr::ValuePointerRef;

let pointer = ValuePointerRef::Origin;
let pointer = pointer.push_key("a");
let pointer = pointer.push_index(2);
// now `pointer` points to "a".2

A ValuePointerRef is an immutable data structure, so it is cheap to extend and to copy. However, if you want to store it inside an owned type, you may want to convert it to a ValuePointer instead using self.to_owned().

Variants

Origin

Key

Fields

key: &'a str

prev: &'a ValuePointerRef<'a>

Index

Fields

index: usize

prev: &'a ValuePointerRef<'a>

Implementations

impl<'a> ValuePointerRef<'a>

pub fn push_key(&'a self, key: &'a str) -> Self

Extend self such that it points to the next subvalue at the given key.

pub fn push_index(&'a self, index: usize) -> Self

Extend self such that it points to the next subvalue at the given index.

pub fn is_origin(&self) -> bool

Return true if the pointer is at the origin.

pub fn last_field(&self) -> Option<&str>

Return the last field encountered if there is one.

pub fn first_field(&self) -> Option<&str>

Return the first field encountered if there is one. Eg; “toto.tata[42].lol” -> “toto” “toto” -> “toto” “[1][2][3]” -> None “” -> None

pub fn to_owned(&self) -> ValuePointer

Convert self to its owned version

Trait Implementations

impl<'a> Clone for ValuePointerRef<'a>

fn clone(&self) -> ValuePointerRef<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Default for ValuePointerRef<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Copy for ValuePointerRef<'a>