Skip to main content

Crate edjr

Crate edjr 

Source
Expand description

§edjr

Elite Dangerous Journal Reader

A library for parsing Elite Dangerous’s journal files. edjr supports only Elite Dangerous Odyssey.

§Features

  • tokio: provide tokio-based journal reader.
  • stream: provides stream for journal reader.

§Examples

§Read all (sync)

use {
    edjr::{journal::Journal, read::Read},
    std::{error::Error, fs::File, path::PathBuf},
};

fn main() -> Result<(), Box<dyn Error>> {
    let journal_path =
        PathBuf::from("/Path/to/Journals/Journal.date.log");
    let mut journal = Journal::<File>::open(journal_path)?;
    let entries = journal.read_all()?;

    Ok(())
}

§Read all (async, features = tokio)

use {
    edjr::{journal::Journal, async_read::AsyncRead},
    std::{error::Error, path::PathBuf},
    tokio::fs::File,
};

#[tokio::main]
fn main() -> Result<(), Box<dyn Error>> {
    let journal_path =
        PathBuf::from("/Path/to/Journals/Journal.date.log");
    let mut journal = Journal::<File>::open(journal_path).await?;
    let entries = journal.read_all().await?;

    Ok(())
}

View more examples in examples/

Re-exports§

pub use async_read::AsyncRead;
pub use entry::JournalEntry;
pub use event::JournalEvent;
pub use journal::Journal;
pub use read::Read;

Modules§

async_read
Asyncronous reading
elite
Elite associated objects
entry
Journal entry
error
Journal runtime errors
event
Journal event
events
Elite Events
journal
Journal
read
Journal reading
tokiotokio
tokio based edjr’s backend