Struct Journal

pub struct Journal { /* private fields */ }

Represents a journal entry with version and file position.

A journal entry maps a specific version of an AIM file to its byte offset position within that file. This enables efficient random access to specific versions without having to parse the entire file.

Examples

use aimx::aim::Journal;

let journal = Journal::new(1, 100);
assert_eq!(journal.version(), 1);
assert_eq!(journal.position(), 100);

Implementations

impl Journal

pub fn new(version: u32, position: u64) -> Self

Creates a new journal entry with the specified version and position.

Arguments

• version - The version number this entry represents
• position - The byte offset position in the file where this version starts

Returns

A new Journal instance.

Examples

use aimx::aim::Journal;

let journal = Journal::new(2, 150);
assert_eq!(journal.version(), 2);
assert_eq!(journal.position(), 150);

pub fn version(&self) -> u32

Returns the version number of this journal entry.

Returns

The version number as a u32.

Examples

use aimx::aim::Journal;

let journal = Journal::new(3, 200);
assert_eq!(journal.version(), 3);

pub fn position(&self) -> u64

Returns the byte position of this journal entry.

Returns

The byte offset position as a u64.

Examples

use aimx::aim::Journal;

let journal = Journal::new(1, 50);
assert_eq!(journal.position(), 50);

Trait Implementations

impl Clone for Journal

fn clone(&self) -> Journal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Journal

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

Formats the value using the given formatter.

impl PartialEq for Journal

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Journal

impl StructuralPartialEq for Journal