Struct ArcRecursive 

#[repr(transparent)]
pub struct ArcRecursive<T>(pub Arc<Mutex<Option<T>>>);

The parent (origin) anchor definition that may have recursive references to it. This type provides the value for the references and must be placed where the original value is defined. Fields that reference this value (possibly recursively) must be wrapped in ArcRecursion.

use serde::Deserialize;
use serde_saphyr::{ArcRecursion, ArcRecursive};

#[derive(Deserialize)]
struct King {
    name: String,
    coronator: ArcRecursion<King>, // who crowned this king
}

#[derive(Deserialize)]
struct Kingdom {
    king: ArcRecursive<King>,
}

    let yaml = r#"
king: &root
  name: "Aurelian I"
  coronator: *root # this king crowned himself
"#;

    let kingdom_data: Kingdom = serde_saphyr::from_str(yaml).unwrap();
    let coronator = {
        let king_guard = kingdom_data.king.lock().unwrap();
        let king = king_guard.as_ref().expect("king should be initialized");
        king.coronator
            .upgrade()
            .expect("coronator should be alive")
    };

    let coronator_guard = coronator.lock().unwrap();
    let coronator_ref = coronator_guard
        .as_ref()
        .expect("coronator should be initialized");
    assert_eq!(coronator_ref.name, "Aurelian I");

Tuple Fields

0: Arc<Mutex<Option<T>>>

Implementations

impl<T> ArcRecursive<T>

pub fn wrapping(x: T) -> Self

Create a new recursive anchor with an initialized value.

pub fn lock(&self) -> LockResult<MutexGuard<'_, Option<T>>>

Lock the recursive anchor value so that it can be accessed safely.

Trait Implementations

impl<T: Clone> Clone for ArcRecursive<T>

fn clone(&self) -> ArcRecursive<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for ArcRecursive<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for ArcRecursive<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Deref for ArcRecursive<T>

type Target = Arc<Mutex<Option<T>>>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de, T> Deserialize<'de> for ArcRecursive<T>

where T: Deserialize<'de> + Send + Sync + 'static,

Available on crate feature deserialize only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Eq for ArcRecursive<T>

impl<T> From<&ArcRecursive<T>> for ArcRecursion<T>

fn from(ara: &ArcRecursive<T>) -> Self

Converts to this type from the input type.

impl<T> PartialEq for ArcRecursive<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T: Serialize> Serialize for ArcRecursive<T>

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.