Struct devlog::path::LogPath

pub struct LogPath { /* fields omitted */ }

Methods

impl LogPath

Devlog entry files are numbered sequentially, starting from one. Each filename is nine digits with the extension ".devlog"; for example, "000000123.devlog". This ensures that the devlog files appear in sequential order when sorted alphabetically.

pub fn new(dir: &Path, seq_num: usize) -> LogPath

Create a new path with the specified sequence number, which must be at least one and at most MAX_SEQ_NUM.

pub fn from_path(path: PathBuf) -> Option<LogPath>

Parse the sequence number from a filesystem path. Returns None if the filename isn't formatted like "000000123.devlog".

pub fn next(&self) -> Result<LogPath, Error>

Returns the path for the next entry in the sequence. In the unlikely event that the maximum sequence number is reached, returns Error::LogFileLimitExceeded.

pub fn seq_num(&self) -> usize

Returns the sequence number (e.g. "00000123.devlog" would have sequence number 123)

pub fn path(&self) -> &Path

Returns the filesystem path.

Trait Implementations

impl Debug for LogPath

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

Formats the value using the given formatter.

impl Eq for LogPath

impl Ord for LogPath

Order by sequence number.

fn cmp(&self, other: &Self) -> Ordering

This method returns an [Ordering] between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<LogPath> for LogPath

Equal if and only if the sequence numbers are equal.

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 !=.

impl PartialOrd<LogPath> for LogPath

Order by sequence number.

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for LogPath