Struct contrail::Value

pub struct Value<M, T> { /* fields omitted */ }

A reference to a value stored on the trail.

The type parameter T is the type of value stored on the trail, and the type parameter M represents how the value is stored on the trail. A Value<Backtrackable, T> is stored on the trail in backtrackable memory, whereas a Value<NonBacktrackable, T> is stored on the trail in non-backtrackable memory.

Instead of using Value directly, it's often easier to use the type definitions BacktrackableValue and NonBacktrackableValue.

Methods

impl<M, T> Value<M, T> where
    M: StorageMode,
    T: Bytes, 

pub fn new(builder: &mut TrailBuilder, val: T) -> Self

Creates a new Value with the given value.

The Value is usable after the TrailBuilder used to create it is finished.

Examples

use contrail::{BacktrackableValue, TrailBuilder};

let mut builder = TrailBuilder::new();
let value = BacktrackableValue::new(&mut builder, 'b');
let trail = builder.finish();

// the value is usable now
assert_eq!(value.get(&trail), 'b');

pub fn get(self, trail: &Trail) -> T

Gets the value from the trail.

Examples

use contrail::{BacktrackableValue, TrailBuilder};

let mut builder = TrailBuilder::new();
let value = BacktrackableValue::new(&mut builder, 5);
let mut trail = builder.finish();

assert_eq!(value.get(&trail), 5);

pub fn set(self, trail: &mut Trail, new_val: T)

Sets the value on the trail.

Examples

use contrail::{BacktrackableValue, TrailBuilder};

let mut builder = TrailBuilder::new();
let value = BacktrackableValue::new(&mut builder, 5);
let mut trail = builder.finish();

value.set(&mut trail, 42);
assert_eq!(value.get(&trail), 42);

pub fn update(self, trail: &mut Trail, f: impl FnOnce(T) -> T)

Updates the value on the trail using the given function.

Examples

use contrail::{BacktrackableValue, TrailBuilder};

let mut builder = TrailBuilder::new();
let value = BacktrackableValue::new(&mut builder, 5);
let mut trail = builder.finish();

value.update(&mut trail, |x| x * x);
assert_eq!(value.get(&trail), 25);

Trait Implementations

impl<M, T> Clone for Value<M, T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M, T> Copy for Value<M, T>

impl<M, T> Debug for Value<M, T> where
    M: StorageMode, 

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

Formats the value using the given formatter.

impl<M, T> Eq for Value<M, T>

impl<M, T> PartialEq<Value<M, T>> for Value<M, T>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.