Enum ReservedFile 

pub enum ReservedFile {
    Index,
    Log,
}

A reserved OKF filename with defined meaning at any level of the hierarchy.

Reserved files MUST NOT be used for concept documents (spec §3.1).

Variants

Index

index.md — directory listing for progressive disclosure (§6).

Log

log.md — chronological update history (§7).

Implementations

impl ReservedFile

pub fn filename(self) -> &'static str

The on-disk filename for this reserved file.

Trait Implementations

impl Clone for ReservedFile

fn clone(&self) -> ReservedFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ReservedFile

impl Debug for ReservedFile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReservedFile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ReservedFile

impl PartialEq for ReservedFile

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ReservedFile

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ReservedFile