Struct glock::GLockBuilder

pub struct GLockBuilder { /* private fields */ }

A GLockBuilder can be used to construct nested GLocks. In Rust, inner structs are initialized before their outer container structs. In glock, parent lock kernels must be initialized before child lock kernels. To resolve this, a GLockBuilder can be used to initialize the parent lock kernel first, then accept the containing struct in build().

Example

use glock::{ GLock, GLockBuilder };

struct Parent {
    child1: GLock<u32>,
    child2: GLock<u32>,
}

let parent_lock = {

    let parent_lock_builder = GLockBuilder::new_root_builder();

    let parent = Parent {
        child1: parent_lock_builder.new_child(0u32).unwrap(),
        child2: parent_lock_builder.new_child(0u32).unwrap(),
    };

    parent_lock_builder.build(parent).unwrap()
};

Implementations

impl GLockBuilder

pub fn new_root_builder() -> GLockBuilder

Creates a new root GLock builder

pub fn new_child_builder(&self) -> LockResult<GLockBuilder>

Creates a builder for a GLock that is a child of the current GLock.

pub fn new_child<T>(&self, data: T) -> LockResult<GLock<T>>

Creates a new Glock that is a child of the current GLock and protects the specified.

pub fn build<T>(self, data: T) -> LockResult<GLock<T>>

Builds the GLock object that protects the specified data.