Struct ZonWriter 

pub struct ZonWriter { /* private fields */ }

Implementations

impl ZonWriter

pub fn new() -> Self

Examples found in repository

examples/basic.rs (line 7)

fn main() {
    println!("Running ZON Basic Example...");

    // 1. Write
    let mut writer = ZonWriter::new();
    let text_off = writer.write_string("Hello Zero-Copy World!");
    let num_off = writer.write_u32(42);
    
    writer.set_root(text_off);
    
    println!("Written {} bytes.", writer.len());
    
    // 2. Read
    let buffer = writer.as_bytes();
    let reader = ZonReader::new(buffer).expect("Buffer verification failed");
    
    let root = reader.read_u32(8).unwrap();
    let text = reader.read_string(root).unwrap();
    let num = reader.read_u32(num_off).unwrap();
    
    println!("Read Root String: {}", text);
    println!("Read Number: {}", num);
    
    assert_eq!(text, "Hello Zero-Copy World!");
    assert_eq!(num, 42);
    
    println!("Success!");
}

pub fn len(&self) -> usize

Examples found in repository

examples/basic.rs (line 13)

fn main() {
    println!("Running ZON Basic Example...");

    // 1. Write
    let mut writer = ZonWriter::new();
    let text_off = writer.write_string("Hello Zero-Copy World!");
    let num_off = writer.write_u32(42);
    
    writer.set_root(text_off);
    
    println!("Written {} bytes.", writer.len());
    
    // 2. Read
    let buffer = writer.as_bytes();
    let reader = ZonReader::new(buffer).expect("Buffer verification failed");
    
    let root = reader.read_u32(8).unwrap();
    let text = reader.read_string(root).unwrap();
    let num = reader.read_u32(num_off).unwrap();
    
    println!("Read Root String: {}", text);
    println!("Read Number: {}", num);
    
    assert_eq!(text, "Hello Zero-Copy World!");
    assert_eq!(num, 42);
    
    println!("Success!");
}

pub fn is_empty(&self) -> bool

pub fn as_bytes(&self) -> &[u8]

Examples found in repository

examples/basic.rs (line 16)

fn main() {
    println!("Running ZON Basic Example...");

    // 1. Write
    let mut writer = ZonWriter::new();
    let text_off = writer.write_string("Hello Zero-Copy World!");
    let num_off = writer.write_u32(42);
    
    writer.set_root(text_off);
    
    println!("Written {} bytes.", writer.len());
    
    // 2. Read
    let buffer = writer.as_bytes();
    let reader = ZonReader::new(buffer).expect("Buffer verification failed");
    
    let root = reader.read_u32(8).unwrap();
    let text = reader.read_string(root).unwrap();
    let num = reader.read_u32(num_off).unwrap();
    
    println!("Read Root String: {}", text);
    println!("Read Number: {}", num);
    
    assert_eq!(text, "Hello Zero-Copy World!");
    assert_eq!(num, 42);
    
    println!("Success!");
}

pub fn write_u32(&mut self, val: u32) -> u32

Appends the 4 bytes of val to the buffer. Returns the offset (index) where those bytes were written.

Examples found in repository

examples/basic.rs (line 9)

fn main() {
    println!("Running ZON Basic Example...");

    // 1. Write
    let mut writer = ZonWriter::new();
    let text_off = writer.write_string("Hello Zero-Copy World!");
    let num_off = writer.write_u32(42);
    
    writer.set_root(text_off);
    
    println!("Written {} bytes.", writer.len());
    
    // 2. Read
    let buffer = writer.as_bytes();
    let reader = ZonReader::new(buffer).expect("Buffer verification failed");
    
    let root = reader.read_u32(8).unwrap();
    let text = reader.read_string(root).unwrap();
    let num = reader.read_u32(num_off).unwrap();
    
    println!("Read Root String: {}", text);
    println!("Read Number: {}", num);
    
    assert_eq!(text, "Hello Zero-Copy World!");
    assert_eq!(num, 42);
    
    println!("Success!");
}

pub fn write_string(&mut self, val: &str) -> u32

First, append a 4-byte length (u32). Then, append the raw string bytes. Crucial: Append padding zeros until the buffer’s total size is a multiple of 4 bytes. Returns the offset where the length was written.

Examples found in repository

examples/basic.rs (line 8)

fn main() {
    println!("Running ZON Basic Example...");

    // 1. Write
    let mut writer = ZonWriter::new();
    let text_off = writer.write_string("Hello Zero-Copy World!");
    let num_off = writer.write_u32(42);
    
    writer.set_root(text_off);
    
    println!("Written {} bytes.", writer.len());
    
    // 2. Read
    let buffer = writer.as_bytes();
    let reader = ZonReader::new(buffer).expect("Buffer verification failed");
    
    let root = reader.read_u32(8).unwrap();
    let text = reader.read_string(root).unwrap();
    let num = reader.read_u32(num_off).unwrap();
    
    println!("Read Root String: {}", text);
    println!("Read Number: {}", num);
    
    assert_eq!(text, "Hello Zero-Copy World!");
    assert_eq!(num, 42);
    
    println!("Success!");
}

pub fn set_root(&mut self, offset: u32)

Updates the root offset in the header. The header is always at the start of the buffer.

Examples found in repository

examples/basic.rs (line 11)

fn main() {
    println!("Running ZON Basic Example...");

    // 1. Write
    let mut writer = ZonWriter::new();
    let text_off = writer.write_string("Hello Zero-Copy World!");
    let num_off = writer.write_u32(42);
    
    writer.set_root(text_off);
    
    println!("Written {} bytes.", writer.len());
    
    // 2. Read
    let buffer = writer.as_bytes();
    let reader = ZonReader::new(buffer).expect("Buffer verification failed");
    
    let root = reader.read_u32(8).unwrap();
    let text = reader.read_string(root).unwrap();
    let num = reader.read_u32(num_off).unwrap();
    
    println!("Read Root String: {}", text);
    println!("Read Number: {}", num);
    
    assert_eq!(text, "Hello Zero-Copy World!");
    assert_eq!(num, 42);
    
    println!("Success!");
}

Trait Implementations

impl Default for ZonWriter

fn default() -> Self

Returns the “default value” for a type.