Zero-Cost Typestate Pattern with PhantomData

Snippet

Zero-Cost Typestate Pattern with PhantomData

The Typestate pattern uses Rust's type system to enforce state transitions at compile time. By using PhantomData, we can differentiate states without incurring any runtime memory overhead. This ensures that methods like 'process' can only be called once the data has reached the 'Checked' state.

snippet.rs
rust
use std::marker::PhantomData;
 
struct Unchecked;
struct Checked;
 
struct Data<S> {
    value: String,
    _state: PhantomData<S>,
}
 
impl Data<Unchecked> {
    fn new(v: &str) -> Self { 
        Data { value: v.into(), _state: PhantomData }
    }
    
    fn validate(self) -> Data<Checked> {
        // Perform complex validation logic here
        Data { value: self.value, _state: PhantomData }
    }
}
 
impl Data<Checked> {
    fn process(&self) {
        println!("Processing validated data: {}", self.value);
    }
}

Breakdown

struct Unchecked;

A zero-sized marker type representing the initial state.

_state: PhantomData<S>,

Informs the compiler that Data logically 'owns' a type S without storing it.

fn validate(self) -> Data<Checked>

Consumes the current state and returns a new state, making the old one inaccessible.

Previous snippet Next snippet

From your library

Zero-Cost Typestate Pattern with PhantomData

Related