Struct Reference 

pub struct Reference { /* private fields */ }

A reference to another value of the input (r: and R:).

PHP numbers the values of the input in the order they appear (starting with 1 for the top-level value) and a reference repeats the value of a number. The deserializer does not resolve references: it passes them on as extension atoms of this type, the serializer writes them as they are. Like when deserializing, references have to refer to a value before them (r: to an object), otherwise they are an error.

This is basically a marker only. The number refers to a position in the whole input which the value that holds the reference cannot know, and what it refers to is gone once the input was deserialized: the values that the types skipped have a number too, and the numbering rules (keys and R: have no number, r: has one) are those of PHP. Short of reimplementing the deserializer there is no way to look up the value. What this type is good for is to detect references and to write the input back unchanged:

use deser_php::{Reference, ReferenceKind};

// `[$a, &$a]` with `$a = 5`, the second entry refers to the first
let input = b"a:2:{i:0;i:5;i:1;R:2;}";
let value: (u32, Reference) = deser_php::from_slice(input).unwrap();
assert_eq!(value.1, Reference::new(ReferenceKind::Value, 2));
assert_eq!(deser_php::to_vec(&value).unwrap(), input);

// the fallback is the number: this is not the value it refers to
let value: Vec<u32> = deser_php::from_slice(input).unwrap();
assert_eq!(value, [5, 2]);

The fallback of the extension is the number, other types than this one receive an integer.

Implementations

impl Reference

pub const fn new(kind: ReferenceKind, number: u64) -> Reference

Creates a reference.

pub const fn kind(self) -> ReferenceKind

Returns the kind of the reference.

pub const fn number(self) -> u64

Returns the number of the value it refers to.

The top-level value is 1.

Trait Implementations

impl Clone for Reference

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Reference

impl Debug for Reference

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Reference

fn deserialize_atom( slot: &mut Slot<Self>, atom: Atom<'_>, state: &mut State, ) -> Result<(), Error>

Deserializes an atom into the slot.

fn expecting() -> Cow<'static, str>

Returns what the value expects, for error messages.

fn deserialize_into<'out>( out: &'out mut Option<T>, state: &mut State, ) -> SinkHandle<'out, 'de>

Creates a sink that deserializes the value into the given slot.

fn deserialize_borrowed_atom( slot: &mut Slot<T, Self>, atom: Atom<'de>, state: &mut State, ) -> Result<(), Error>

Deserializes an atom that borrows from the data being deserialized into the slot.

fn describe_type(d: &mut dyn Describe)

Describes the Rust shape of the type.

fn initial_value() -> Option<T>

Provides the value of a missing struct field.

fn deserialize_update<'out>( value: &'out mut T, state: &mut State, ) -> SinkHandle<'out, 'de>

Creates a sink that updates an existing value.

impl Eq for Reference

impl Extension for Reference

fn name(&self) -> &str

Returns the human readable name of the extension type.

fn fallback(&self) -> Atom<'_>

Lowers the value into the core data model.

impl Hash for Reference

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Reference

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Reference

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for Reference

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Reference

fn serialize<'a>(value: &'a Self, _state: &mut State) -> Result<Emit<'a>, Error>

Serializes the value.

fn finish(value: &T, state: &mut State) -> Result<(), Error>

Invoked after the serialization finished.

fn is_optional(value: &T) -> bool

Checks if the value represents an optional value.

fn describe(value: &T, d: &mut dyn Describe)

Describes the Rust shape of the value.

fn container_shape(value: &T) -> ContainerShape

Returns the shape of the value if it’s a map or sequence.

impl StructuralPartialEq for Reference